API reference › Preferred lists › Preferred list
Retrieve paginated preference list with optional filters
GET /v1/settings/portal/preference-list
- Scope
settings_preferred_users:read- Roles
- client, consumer, service-provider
Fetch a paginated list of preference list entries. Allows filtering, searching, and sorting.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | |
columns | string | |
sortBy | string | |
sortOrder | string | One of: |
perPage | integer | |
clientId | string | |
consumerId | string | |
serviceProviderId | string | |
startDate | string (date) | |
endDate | string (date) |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/portal/preference-list" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Success
Success
{
"success": true,
"data": [
{
"id": 1,
"preferredUser": {
"id": "CLT-XXISS8",
"label": "Client2"
},
"preferredUserRoleName": "admin",
"preferredRole": {
"id": 2,
"label": "Client",
"slug": "client"
},
"preferredUserImage": "https://cdn.example.com/image.png",
"preferredUserOnlineStatus": "online",
"notes": "Added by the scheduler.",
"preferredDate": "2026-01-15",
"isBehalfOfOrg": true,
"isBehalfOfRole": "string",
"providerServices": [
null
]
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 1
}
}Response fields (23)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (16 nested) | |
meta | object (4 nested) |
Nested fields
data 16 fields
| Field | Type | Description |
|---|---|---|
data[].id | integer | Example |
data[].preferredUser | object | |
data[].preferredUser.id | string | Example |
data[].preferredUser.label | string | Example |
data[].preferredUserRoleName | string or null | Example |
data[].preferredRole | object | |
data[].preferredRole.id | integer | Example |
data[].preferredRole.label | string | Example |
data[].preferredRole.slug | string | Example |
data[].preferredUserImage | string or null | Example |
data[].preferredUserOnlineStatus | string | Example |
data[].notes | string or null | Example |
data[].preferredDate | string | Example |
data[].isBehalfOfOrg | boolean | Example |
data[].isBehalfOfRole | string or null | |
data[].providerServices | array of any or null |
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
{
"success": false,
"message": "Failed to retrieve.",
"errors": {
"search": [
"Invalid search parameter"
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object |
401 Not signed in
Missing, invalid or expired API key.
{
"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
Server Error
{
"success": false,
"message": "Something went wrong!",
"errors": "Unexpected error occurred"
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |