API reference › Service setup › Specializations

Retrieve a specialization by ID

GET /v1/specializations/{specialization}

Scope
settings_service_setup:read
Roles
admin, scheduler

Fetch a single specialization by its ID.

Parameters

Path parameters

NameTypeDescription
specialization requiredinteger

ID of the specialization to retrieve.

Example 5.

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

Example request

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

Try it

Responses

200 Specialization retrieved successfully

Specialization retrieved successfully.

JSON
{
  "success": true,
  "message": "Specialization retrieved successfully!",
  "data": {
    "id": 1,
    "name": {
      "id": 1,
      "label": "Example label"
    },
    "serviceBody": {
      "id": 1,
      "label": "Example label"
    },
    "requirement": "preferred",
    "notes": "Added by the scheduler."
  }
}
Response fields (12)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Specialization retrieved successfully!.

dataobject
data.idinteger

Example 1.

data.nameobject
data.name.idinteger

Example 1.

data.name.labelstring

Example Example label.

data.serviceBodyobject or null
data.serviceBody.idinteger

Example 1.

data.serviceBody.labelstring

Example Example label.

data.requirementstring or null

Example preferred.

data.notesstring or null

Example Added by the scheduler..

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 .

404 Not found

Specialization not found.

JSON
{
  "success": false,
  "message": "Specialization with ID 5 not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Specialization with ID 5 not found..

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!.