Retrieve a list of consumers
GET /v1/consumers
- Scope
consumers:read- Roles
- admin, scheduler
Fetches a paginated list of consumers based on filters, search criteria, and sorting options.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search consumers by name, email, or consumer ID. |
serviceTypes | string | Comma-separated list of service type IDs. |
hearingStatus | string | Hearing status filter. |
isPublished | boolean | Filter consumers by their Published status. Example |
needsReview | boolean | Only consumers whose guardianship review is open (turned 18 with guardians still acting, pending or snoozed). Example |
communicationModes | string | Comma-separated list of communication mode IDs. |
associatedClient | string | Comma-separated list of client IDs associated with the consumer. |
status | integer | Filter by status ID. |
priority | integer | Filter by priority ID. |
startDate | string (date) | Start date for filtering consumers (YYYY-MM-DD). |
endDate | string (date) | End date for filtering consumers (YYYY-MM-DD). |
sortBy | string | Field to sort by (e.g., 'user', 'priority', 'created_at'). |
sortOrder | string | Sort order: ascending ('asc') or descending ('desc'). One of: |
perPage | integer | Number of records per page. Example |
columns | string | Comma-separated list of columns for filtering or display. Valid columns: user, status, priority, serviceTypes, hearingStatus, communicationModes, associatedClient. Example |
portalAccess | boolean | Filter by the Portal Access column. Example |
inviteState | string | Filter by the Invite State column, using the same rule as the inviteState badge. One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/consumers" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Consumers retrieved successfully
Consumers retrieved successfully
{
"success": true,
"data": [
{
"id": "USR-LBW3CV",
"name": "Example name",
"onlineStatus": "online",
"email": "user@example.com",
"phone": "+1-555-0142",
"logo": "https://cdn.example.com/image.png",
"status": 1,
"statusName": "Active",
"statusChangedAt": "2026-06-30 14:29:00",
"publishedAt": "2026-06-30 14:29:00",
"priority": 1,
"priorityName": "Example name",
"associatedClient": [
{
"client": "CLT-PJ6TFP",
"clientName": "Test2",
"clientImage": "hi",
"relationship": "employee"
}
],
"serviceTypes": [
6
],
"serviceTypesName": [
"string"
],
"hearingStatus": {
"id": "string",
"label": "Example label"
},
"communicationModes": [
1
],
"communicationModesName": [
"ASL (American Sign Language)"
],
"portalAccess": true,
"canLogin": true,
"isPublished": true,
"activeAssignment": 1,
"gender": {
"id": "string",
"label": "Example label"
},
"requiresPrimaryReassignmentOnDelete": "string",
"otherActiveRoles": "string"
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 1
}
}Response fields (40)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (33 nested) | |
meta | object (4 nested) |
Nested fields
data 33 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[].phone | string or null | Example |
data[].logo | string or null | Example |
data[].status | integer or null | Example |
data[].statusName | string or null | Example |
data[].statusChangedAt | string (date-time) or null | When the consumer entered its current status Example |
data[].publishedAt | string (date-time) or null | When the consumer entered its current publication state Example |
data[].priority | integer or null | Example |
data[].priorityName | string or null | Example |
data[].associatedClient | array of object | |
data[].associatedClient[].client | string | Example |
data[].associatedClient[].clientName | string | Example |
data[].associatedClient[].clientImage | string | Example |
data[].associatedClient[].relationship | string | Example |
data[].serviceTypes | array of integer | |
data[].serviceTypesName | array of string | |
data[].hearingStatus | object or null | |
data[].hearingStatus.id | string | |
data[].hearingStatus.label | string | Example |
data[].communicationModes | array of integer | |
data[].communicationModesName | array of string | |
data[].portalAccess | boolean | Example |
data[].canLogin | boolean | Example |
data[].isPublished | boolean or null | Example |
data[].activeAssignment | integer | Example |
data[].gender | object or null | |
data[].gender.id | string | |
data[].gender.label | string | Example |
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 parameters
{
"success": false,
"message": "Invalid filters provided. Please check the query parameters."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized - Token missing or invalid
{
"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 'consumers: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."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |