API reference › Providers

Get all service providers' names and IDs

GET /v1/provider/name-list

Scope
providers:read
Roles
admin, scheduler

Fetches a list of all service providers with only their ID and name. Optionally filters by published status.

Parameters

Query parameters

NameTypeDescription
isPublishedboolean

Filter by published status. If true, only published providers are returned. If false, only unpublished providers are returned. If omitted, all providers 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/provider/name-list" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 List of Service Providers retrieved successfully

List of Service Providers retrieved successfully

JSON
{
  "success": true,
  "message": "Service Providers fetched successfully!",
  "data": [
    {
      "id": "1",
      "label": "John Doe",
      "value": "1",
      "image": "logo.png"
    },
    {
      "id": "2",
      "label": "Jane Smith",
      "value": "2",
      "image": null
    }
  ]
}
Response fields (7)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service Providers fetched successfully!.

dataarray of object
data[].idstring

Example 1.

data[].labelstring

Example John Doe.

data[].valuestring

Example 1.

data[].imagestring

Example logo.png.

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 'providers: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 'providers: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..