Retrieve specific tab details of a client
GET /v1/clients/{client}/tab/{tab}
- Scope
clients:read- Roles
- admin, scheduler
Fetches the details for a specific tab within a client, based on the provided client ID and tab identifier.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
client required | string | Unique identifier of the client Example |
tab required | string | Identifier for the specific tab to fetch (e.g., 'general', 'requirement_preferences', 'rates_billing', 'document_notes','associated_consumers','assignmentStats','historyLogs') One of: |
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search the audit log. Applies to the |
sortBy | string | Sort column (default: created_at). Applies to the Example |
sortOrder | string | Sort direction (default: desc). Applies to the One of: |
perPage | integer | Rows per page (default: 10). Applies to the Example |
page | integer | Page number (default: 1). Applies to the Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/clients/{client}/tab/{tab}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Client details retrieved successfully
Client details retrieved successfully
{
"success": true,
"message": "Client details retrieved!",
"data": {},
"meta": {
"currentPage": 1,
"lastPage": 3,
"perPage": 10,
"total": 24
}
}Response fields (8)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Absent on the historyLogs tab. Example |
data | object or array of object | One object for the requested tab, or an array of audit entries on historyLogs. See the example for the general tab. |
meta | object or null | Sent on the historyLogs tab only. |
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
401 Not signed in
Unauthorized - authentication required
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
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.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
422 Validation failed
Validation error - Missing or invalid parameters
{
"success": false,
"message": "Validation Failed",
"errors": {
"id": [
"The specified client does not exist."
]
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.id | array of string |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |