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

NameTypeDescription
searchstring

Search consumers by name, email, or consumer ID.

serviceTypesstring

Comma-separated list of service type IDs.

hearingStatusstring

Hearing status filter.

communicationModesstring

Comma-separated list of communication mode IDs.

statusinteger

Filter by status ID.

priorityinteger

Filter by priority ID.

sortBystring

Field to sort by (e.g., 'user', 'priority', 'created_at').

startDatestring (date)

Filter consumers created on/after this date (YYYY-MM-DD).

Example 2025-08-01.

endDatestring (date)

Filter consumers created on/before this date (YYYY-MM-DD).

Example 2025-08-21.

sortOrderstring

Sort order: ascending ('asc') or descending ('desc').

One of: asc, desc.

perPageinteger

Number of records per page.

Example 10.

columnsstring

Comma-separated list of columns for filtering or display. Valid columns: user, status, priority, serviceTypes, hearingStatus, communicationModes, associatedClient.

Example user, status, priority, serviceTypes, hearingStatus, communicationModes, associatedClient.

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

Example request

Shell
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

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

dataarray of object (27 nested)
metaobject (4 nested)

Nested fields

data 27 fields
FieldTypeDescription
data[].idstring

Example CSM-TUENP2.

data[].namestring

Example demo consumer 20august-12.

data[].emailstring

Example user@example.com.

data[].phonestring

Example 9888888888.

data[].logostring or null

Example https://fido-devserver.s3.us-east-1.amazonaws.com/consumers/CSM-TUENP2/logo/sample.jpg.

data[].statusobject
data[].status.idinteger

Example 1.

data[].status.labelstring

Example Active.

data[].priorityobject
data[].priority.idinteger

Example 1.

data[].priority.labelstring

Example High.

data[].associatedClientarray of object
data[].associatedClient[].clientstring

Example CLT-AJHXRX.

data[].associatedClient[].clientNamestring

Example Rate & billing.

data[].associatedClient[].imagestring or null
data[].associatedClient[].relationshipstring

Example Consumer.

data[].serviceTypesarray of object
data[].serviceTypes[].idinteger

Example 1.

data[].serviceTypes[].labelstring

Example ASL.

data[].hearingStatusobject or null
data[].hearingStatus.idstring

Example deaf.

data[].hearingStatus.labelstring

Example Deaf.

data[].communicationModesarray of object
data[].communicationModes[].idinteger

Example 1.

data[].communicationModes[].labelstring

Example ASL (American Sign Language).

data[].portalAccessboolean or null

Example false.

data[].isPublishedboolean

Example true.

meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 0.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 1.

400 Bad request

Bad Request - Invalid parameters

JSON
{
  "success": false,
  "message": "Invalid filters provided. Please check the query parameters."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid filters provided. Please check the query parameters..

401 Not signed in

Unauthorized - Token missing or invalid

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

Scope, tenant, IP allow-list or RBAC check failed.

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 .

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."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..