API reference › Service setup › Clearances
List all clearance bodies
GET /v1/clearance-bodies
- Scope
settings_service_setup:read- Roles
- admin, scheduler
Fetches all clearance 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
curl "https://api.fetchfido.ai/v1/clearance-bodies" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Clearance Body Fetched Successfully
Clearance Body Fetched Successfully
{
"success": true,
"message": "Clearance Body Fetched Successfully",
"code": 200,
"data": [
{
"id": 2,
"label": "FBI",
"value": 2
}
]
}Response fields (7)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
code | integer | Example |
data | array of object | |
data[].id | integer | Example |
data[].label | string | Example |
data[].value | integer | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Something went wrong
{
"success": false,
"message": "Something went wrong!",
"errors": "Error fetching Clearance Bodies: SQLSTATE[HY000] [1049] Unknown database 'clearances_db'"
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |