API reference › Service setup › Service types

List all service bodies

GET /v1/service-bodies

Scope
settings_service_setup:read
Roles
admin, scheduler

Fetches all service bodies and returns them in id-label-value format.

Parameters

None of its own.

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

Example request

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

Try it

Responses

200 Service Body Fetched Successfully

Service Body Fetched Successfully

JSON
{
  "success": true,
  "message": "Service Body Fetched Successfully",
  "code": 200,
  "data": [
    {
      "id": 1,
      "label": "ASL",
      "value": 1
    }
  ]
}
Response fields (7)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service Body Fetched Successfully.

codeinteger

Example 200.

dataarray of object
data[].idinteger

Example 1.

data[].labelstring

Example ASL.

data[].valueinteger

Example 1.

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

Something went wrong

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Error fetching Service Bodies: SQLSTATE[HY000] [1045] Access denied for user..."
}
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 Error fetching Service Bodies: SQLSTATE[HY000] [1045] Access denied for user....