API reference › Service setup › Clearances
Retrieve all clearances or filter by tenant ID
GET /v1/clearances
- Scope
settings_service_setup:read- Roles
- admin, scheduler
Fetch a paginated list of all clearances with support for search, sorting, and filtering by tenant ID.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search term to filter clearances by name. Example |
columns | string | Comma-separated list of columns to apply search on (e.g., name). Example |
clearanceId | integer | Filter by specific clearance ID. Example |
clearanceBody | string | Filter by clearance body ID or name. Example |
requirement | string | Filter by requirement type (e.g., required, optional, mandatory, preferred). One of: |
expirationRequired | boolean | Filter clearances based on whether expiration is required. Example |
uploadRequired | boolean | Filter clearances based on whether document upload is required. Example |
sortBy | string | Field to sort results by. Example |
sortOrder | string | Sort order: asc or desc. One of: |
perPage | integer | Number of results per page. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/clearances" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Clearances retrieved successfully
Clearances retrieved successfully.
{
"success": true,
"data": [
{
"id": 1,
"name": "Example name",
"clearanceBody": 1,
"clearanceBodyName": "Example name",
"requirement": "preferred",
"expirationRequired": true,
"uploadRequired": true
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 2
}
}Response fields (14)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object | |
data[].id | integer | Example |
data[].name | string | Example |
data[].clearanceBody | integer | Example |
data[].clearanceBodyName | string | Example |
data[].requirement | string | Example |
data[].expirationRequired | boolean | Example |
data[].uploadRequired | boolean | Example |
meta | object | |
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Invalid argument provided.
{
"success": false,
"message": "Failed to retrieve."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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
Internal server error.
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |