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
| Name | Type | Description |
|---|---|---|
module | string | The caller's portal role. Picks which groups are filled: One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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
{
"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)
| Field | Type | Description |
|---|---|---|
clients | array of object | |
clients[].id | string | Example |
clients[].label | string | Example |
clients[].image | string | Example |
consumers | array of object | |
consumers[].id | string | Example |
consumers[].label | string | Example |
consumers[].image | string | Example |
providers | array of object | |
providers[].id | string | Example |
providers[].label | string | Example |
providers[].image | 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 'settings_preferred_users: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 |