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

NameTypeDescription
searchstring

Search term to filter clearances by name.

Example Top Secret.

columnsstring

Comma-separated list of columns to apply search on (e.g., name).

Example name,clearanceBody.

clearanceIdinteger

Filter by specific clearance ID.

Example 1.

clearanceBodystring

Filter by clearance body ID or name.

Example 2.

requirementstring

Filter by requirement type (e.g., required, optional, mandatory, preferred).

One of: required, optional, mandatory, preferred. Example optional.

expirationRequiredboolean

Filter clearances based on whether expiration is required.

Example true.

uploadRequiredboolean

Filter clearances based on whether document upload is required.

Example true.

sortBystring

Field to sort results by.

Example name.

sortOrderstring

Sort order: asc or desc.

One of: asc, desc. Example asc.

perPageinteger

Number of results 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/clearances" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Clearances retrieved successfully

Clearances retrieved successfully.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

dataarray of object
data[].idinteger

Example 1.

data[].namestring

Example Example name.

data[].clearanceBodyinteger

Example 1.

data[].clearanceBodyNamestring

Example Example name.

data[].requirementstring

Example preferred.

data[].expirationRequiredboolean

Example true.

data[].uploadRequiredboolean

Example true.

metaobject
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 2.

400 Bad request

Invalid argument provided.

JSON
{
  "success": false,
  "message": "Failed to retrieve."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

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

Internal server error.

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

Example false.

messagestring

Example Something went wrong!.