API reference › Preferred lists › Preferred list

Get preferred list filter options

GET /v1/settings/portal/preference-list-filter-options

Scope
settings_preferred_users:read
Roles
client, consumer, service-provider

Returns categorized filter options (clients, consumers, providers) from the preferred list.

Parameters

Query parameters

NameTypeDescription
modulestring

The caller's portal role. Picks which groups are filled: client and consumer return providers only, service-provider returns all three. Omitted, every group comes back empty.

One of: client, consumer, service-provider. Example client.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/portal/preference-list-filter-options" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Successfully retrieved filter options

Successfully retrieved filter options

JSON
{
  "clients": [
    {
      "id": "CLT-GGM6R1",
      "label": "Client1",
      "image": "https://d3t50b2fzyr6w1.cloudfront.net/organizations/ORG-LQEKFW/clients/CLT-RVQLPP/689477ec21a93_Test.jpg"
    }
  ],
  "consumers": [
    {
      "id": "CSM-YWUOOH",
      "label": "Consumer1",
      "image": "https://d3t50b2fzyr6w1.cloudfront.net/organizations/ORG-LQEKFW/clients/CLT-AZEKLZ/68b97388cabd8_Test.jpg"
    }
  ],
  "providers": [
    {
      "id": "SPR-WHWVON",
      "label": "ServiceProvider2",
      "image": "https://d3t50b2fzyr6w1.cloudfront.net/service_providers/SPR-MD5MK3/logo/689492853dac8_Test.jpg"
    }
  ]
}
Response fields (12)
FieldTypeDescription
clientsarray of object
clients[].idstring

Example CLT-GGM6R1.

clients[].labelstring

Example Client1.

clients[].imagestring

Example https://d3t50b2fzyr6w1.cloudfront.net/organizations/ORG-LQEKFW/clients/CLT-RVQLPP/689477ec21a93_Test.jpg.

consumersarray of object
consumers[].idstring

Example CSM-YWUOOH.

consumers[].labelstring

Example Consumer1.

consumers[].imagestring

Example https://d3t50b2fzyr6w1.cloudfront.net/organizations/ORG-LQEKFW/clients/CLT-AZEKLZ/68b97388cabd8_Test.jpg.

providersarray of object
providers[].idstring

Example SPR-WHWVON.

providers[].labelstring

Example ServiceProvider2.

providers[].imagestring

Example https://d3t50b2fzyr6w1.cloudfront.net/service_providers/SPR-MD5MK3/logo/689492853dac8_Test.jpg.

401 Not signed in

Unauthorized - authentication required

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

Example false.

messagestring

Example An unexpected error occurred. Please try again later..