Retrieve a list of clients
GET /v1/clients
- Scope
clients:read- Roles
- admin, scheduler
Fetches a paginated list of clients based on search criteria, filters, and sorting options.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter clients by name, email, or client_id. Example |
priority | integer | Filter clients by priority ID. Example |
status | integer | Filter clients by status ID. Example |
portalAccess | boolean | Filter clients by their Portal Access status. Example |
inviteState | string | Filter by the Invite State column, using the same rule as the inviteState badge. One of: |
isPublished | boolean | Filter clients by their Published status. Example |
sortBy | string | Sort clients by a specific field (e.g., 'clientName', 'created_at'). Example |
sortOrder | string | Sorting order: ascending ('asc') or descending ('desc'). One of: |
perPage | integer | Number of clients to retrieve per page. Example |
columns | string | Search query within visible column content. Example |
startDate | string (date) | Filter clients created on or after this date (YYYY-MM-DD). |
endDate | string (date) | Filter clients created on or before this date (YYYY-MM-DD). |
localSearch | string | The table's own search box: matches only the columns named in |
page | integer | Page number (default: 1). Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/clients" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Clients retrieved successfully
Clients retrieved successfully
{
"success": true,
"data": [
{
"id": "CLT-XWB2RY",
"name": "Example name",
"onlineStatus": "online",
"email": "user@example.com",
"logo": "https://cdn.example.com/image.png",
"phone": "+1-555-0142",
"portalAccess": true,
"canLogin": true,
"inviteState": "invited",
"inviteExpiresAt": "string",
"status": 1,
"statusName": "Active",
"priority": 1,
"priorityName": "Example name",
"isPublished": true,
"addressLine1": "123 Main St",
"addressLine2": "Suite 200",
"city": "Austin",
"state": "string",
"postalCode": "90210",
"contactName": "Jane Smith",
"contactEmail": "user@example.com",
"contactPhone": "+1-555-0142",
"contactPhoneExtension": "101",
"contactImage": "https://cdn.example.com/image.png",
"activeAssignments": 3,
"lastAssignmentDate": "2026-08-21",
"statusChangedAt": "2026-06-30 14:29:07",
"publishedAt": "2026-06-30 14:29:07",
"gender": {
"id": "string",
"label": "Example label"
},
"hearingStatus": {
"id": "string",
"label": "Example label"
},
"industry": [
null
],
"requiresPrimaryReassignmentOnDelete": "string",
"otherActiveRoles": "string"
}
],
"meta": {
"currentPage": 1,
"lastPage": 5,
"perPage": 10,
"total": 50
}
}Response fields (45)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (38 nested) | |
meta | object (4 nested) |
Nested fields
data 38 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].name | string or null | Example |
data[].onlineStatus | string | Example |
data[].email | string or null | Example |
data[].logo | string or null | Example |
data[].phone | string or null | Example |
data[].portalAccess | boolean | Example |
data[].canLogin | boolean | Example |
data[].inviteState | string | One of: |
data[].inviteExpiresAt | string (date-time) or null | When the invite link expires or expired; null when there is no invite link |
data[].status | integer or null | Example |
data[].statusName | string or null | Example |
data[].priority | integer or null | Example |
data[].priorityName | string or null | Example |
data[].isPublished | boolean | Example |
data[].addressLine1 | string or null | Example |
data[].addressLine2 | string or null | Example |
data[].city | string or null | Example |
data[].state | string or null | |
data[].postalCode | string or null | Example |
data[].contactName | string or null | Example |
data[].contactEmail | string or null | Example |
data[].contactPhone | string or null | Example |
data[].contactPhoneExtension | string or null | Example |
data[].contactImage | string or null | Example |
data[].activeAssignments | integer | Count of active assignments and shifts linked to the client Example |
data[].lastAssignmentDate | string (date) or null | Latest start date across the client's active assignments and shifts Example |
data[].statusChangedAt | string (date-time) or null | When the client entered its current status Example |
data[].publishedAt | string (date-time) or null | When the client entered its current publication state Example |
data[].gender | object or null | |
data[].gender.id | string | |
data[].gender.label | string | Example |
data[].hearingStatus | object or null | |
data[].hearingStatus.id | string | |
data[].hearingStatus.label | string | Example |
data[].industry | array of any or null | |
data[].requiresPrimaryReassignmentOnDelete | string | |
data[].otherActiveRoles | string |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Bad Request - Invalid query parameters
{
"success": false,
"message": "Invalid parameters. Ensure all required filters are correct."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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
Scope, tenant, IP allow-list or RBAC check failed.
{
"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 |
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 |