API reference › Service setup › Specializations

List Specializations with filtering, pagination, and sorting

GET /v1/specializations

Scope
settings_service_setup:read
Roles
admin, scheduler

Retrieve a paginated list of specializations, optionally filtered by tenant ID, search term, or name. Supports sorting and pagination.

Parameters

Query parameters

NameTypeDescription
searchstring

Search keyword for specialization name

Example Interpreter.

columnsstring

Comma-separated list of columns to return

Example id,name,isCustom.

specializationNamestring

Exact specialization name to filter by

Example ASL Interpretation.

sortBystring

Column to sort by

Example name.

sortOrderstring

Sorting order: asc or desc

Example asc.

perPageinteger

Number of records per page

Example 10.

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

Example request

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

Try it

Responses

200 Specializations retrieved successfully

Specializations retrieved successfully

JSON
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Example name",
      "serviceBody": 1,
      "serviceBodyName": "Example name",
      "requirement": "preferred",
      "notes": "Added by the scheduler."
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 3,
    "perPage": 10,
    "total": 27
  }
}
Response fields (13)
FieldTypeDescription
successboolean

Example true.

dataarray of object
data[].idinteger

Example 1.

data[].namestring

Example Example name.

data[].serviceBodyinteger or null

Example 1.

data[].serviceBodyNamestring or null

Example Example name.

data[].requirementstring or null

Example preferred.

data[].notesstring or null

Example Added by the scheduler..

metaobject
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 3.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 27.

400 Bad request

Invalid input or arguments

JSON
{
  "success": false,
  "message": "Invalid tenant ID provided.",
  "errors": {
    "tenantId": [
      "The tenant ID is invalid."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid tenant ID provided..

errorsobject
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_service_setup: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_service_setup: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

Server error

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.