API reference › Preferred lists › Preferred list

Retrieve a specific preference list entry

GET /v1/settings/portal/preference-list/{preference_list}

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

Fetches a single preference list entry based on the provided ID.

Parameters

Path parameters

NameTypeDescription
preference_list requiredinteger

ID of the preference list entry

Example 10.

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/{preference_list}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Preference entry retrieved successfully

Preference entry retrieved successfully

JSON
{
  "success": true,
  "message": "Preference List entry retrieved.",
  "data": {
    "id": 1,
    "preferredUser": {
      "id": "SPR-AJKF8",
      "label": "John Service"
    },
    "preferredUserRoleName": "admin",
    "preferredRole": {
      "id": 1,
      "label": "Example label",
      "slug": "example-slug"
    },
    "preferredUserImage": "https://cdn.example.com/image.png",
    "preferredUserOnlineStatus": "online",
    "notes": "Added by the scheduler.",
    "preferredDate": "2026-01-15",
    "isBehalfOfOrg": true,
    "isBehalfOfRole": "string",
    "providerServices": [
      null
    ]
  }
}
Response fields (19)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Preference List entry retrieved..

dataobject
data.idinteger

Example 1.

data.preferredUserobject
data.preferredUser.idstring

Example SPR-AJKF8.

data.preferredUser.labelstring

Example John Service.

data.preferredUserRoleNamestring or null

Example admin.

data.preferredRoleobject or null
data.preferredRole.idinteger or null

Example 1.

data.preferredRole.labelstring or null

Example Example label.

data.preferredRole.slugstring or null

Example example-slug.

data.preferredUserImagestring or null

Example https://cdn.example.com/image.png.

data.preferredUserOnlineStatusstring

Example online.

data.notesstring or null

Example Added by the scheduler..

data.preferredDatestring

Example 2026-01-15.

data.isBehalfOfOrgboolean

Example true.

data.isBehalfOfRolestring or null
data.providerServicesarray of any or null
401 Not signed in

Missing, invalid or expired API key.

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 .

404 Not found

Preference entry not found

JSON
{
  "success": false,
  "message": "Preference List entry not found.",
  "errors": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Preference List entry not found..

errorsstring
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

Unexpected server error

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Internal server exception message"
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Internal server exception message.