API reference › Clients › Consumers in the client portal
Retrieve a list of consumers in client portal
GET /v1/settings/portal/client/consumers
- Scope
clients:read- Roles
- client
Fetches a paginated list of consumers based on filters, search criteria, and sorting options in client portal.
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. |
communicationModes | string | Comma-separated list of communication mode IDs. |
status | integer | Filter by status ID. |
priority | integer | Filter by priority ID. |
sortBy | string | Field to sort by (e.g., 'user', 'priority', 'created_at'). |
startDate | string (date) | Filter consumers created on/after this date (YYYY-MM-DD). Example |
endDate | string (date) | Filter consumers created on/before this date (YYYY-MM-DD). Example |
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 |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/portal/client/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": "CSM-TUENP2",
"name": "demo consumer 20august-12",
"email": "user@example.com",
"phone": "9888888888",
"logo": "https://fido-devserver.s3.us-east-1.amazonaws.com/consumers/CSM-TUENP2/logo/sample.jpg",
"status": {
"id": 1,
"label": "Active"
},
"priority": {
"id": 1,
"label": "High"
},
"associatedClient": [
{
"client": "CLT-AJHXRX",
"clientName": "Rate & billing",
"image": null,
"relationship": "Consumer"
}
],
"serviceTypes": [
{
"id": 1,
"label": "ASL"
}
],
"hearingStatus": {
"id": "deaf",
"label": "Deaf"
},
"communicationModes": [
{
"id": 1,
"label": "ASL (American Sign Language)"
}
],
"portalAccess": false,
"isPublished": true
}
],
"meta": {
"currentPage": 1,
"lastPage": 0,
"perPage": 10,
"total": 1
}
}Response fields (34)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (27 nested) | |
meta | object (4 nested) |
Nested fields
data 27 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].name | string | Example |
data[].email | string | Example |
data[].phone | string | Example |
data[].logo | string or null | Example |
data[].status | object | |
data[].status.id | integer | Example |
data[].status.label | string | Example |
data[].priority | object | |
data[].priority.id | integer | Example |
data[].priority.label | string | Example |
data[].associatedClient | array of object | |
data[].associatedClient[].client | string | Example |
data[].associatedClient[].clientName | string | Example |
data[].associatedClient[].image | string or null | |
data[].associatedClient[].relationship | string | Example |
data[].serviceTypes | array of object | |
data[].serviceTypes[].id | integer | Example |
data[].serviceTypes[].label | string | Example |
data[].hearingStatus | object or null | |
data[].hearingStatus.id | string | Example |
data[].hearingStatus.label | string | Example |
data[].communicationModes | array of object | |
data[].communicationModes[].id | integer | Example |
data[].communicationModes[].label | string | Example |
data[].portalAccess | boolean or null | Example |
data[].isPublished | boolean | Example |
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 '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."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |