API reference › Clients › Locations

Retrieve specific tab details of a client location

GET /v1/clients/{client}/locations/{location}/tab/{tab}

Scope
clients:read
Roles
admin, scheduler

Fetches the details for a specific tab within a client location, based on the provided location ID and tab identifier.

Parameters

Path parameters

NameTypeDescription
client requiredstring

Unique identifier of the client

Example CLT-VX6R0.

location requiredstring

Unique identifier of the client location

Example CLTLOC-VX6R0.

tab requiredstring

Identifier for the specific tab to fetch (e.g., 'general', 'rates_billing', 'document_notes')

One of: general, rates_billing, document_notes. Example general.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl "https://api.fetchfido.ai/v1/clients/{client}/locations/{location}/tab/{tab}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Client location details retrieved successfully

Client location details retrieved successfully

JSON
{
  "success": true,
  "message": "Location details retrieved!",
  "data": {}
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Location details retrieved!.

dataobject or array of object

One object for the requested tab. See the example for the general tab.

401 Not signed in

Unauthorized - authentication required

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Forbidden. The rates_billing tab is Finances data, so a role without Finance Read is refused it whatever it holds on the record's own module. Every other tab follows the record's module alone.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'clients:read' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'clients:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error - Missing or invalid parameters

JSON
{
  "success": false,
  "message": "Validation Failed",
  "errors": {
    "id": [
      "The specified client location does not exist."
    ]
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation Failed.

errorsobject
errors.idarray of string
429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..