API reference › Clients

Get all clients' names and IDs

GET /v1/clients/name-list

Scope
clients:read or assignments:read or shifts:read or schedule:read or consumers:read or providers:read or finance:read or forms:read

Fetches a list of all clients with only their ID and name. Optionally filters by published status and includes/excludes locations.

Parameters

Query parameters

NameTypeDescription
withoutLocationboolean

Set to true to exclude locations from the response

Default false.

isActiveboolean

Filter by active status. If true, only active clients are returned.

Example true.

isPublishedboolean

Filter by published status. If true, only published clients are returned. If false, only unpublished clients are returned. If omitted, all clients are returned.

Example true.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/clients/name-list" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 List of clients retrieved successfully

List of clients retrieved successfully

JSON
{
  "success": true,
  "message": "Clients fetched successfully!",
  "data": [
    {
      "id": "1",
      "value": "1",
      "label": "Acme Corp",
      "image": "logo.png",
      "locations": [
        {
          "id": "101",
          "value": "101",
          "label": "Acme HQ"
        }
      ]
    },
    {
      "id": "2",
      "value": "2",
      "label": "Globex Inc",
      "image": null,
      "locations": []
    }
  ]
}
Response fields (11)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Clients fetched successfully!.

dataarray of object
data[].idstring

Example 1.

data[].valuestring

Example 1.

data[].labelstring

Example Acme Corp.

data[].imagestring

Example logo.png.

data[].locationsarray of object
data[].locations[].idstring

Example 101.

data[].locations[].valuestring

Example 101.

data[].locations[].labelstring

Example Acme HQ.

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

Example false.

messagestring

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