API reference › Service setup › Certifications
Retrieve all certifications or filter by tenant ID
GET /v1/certifications
- Scope
settings_service_setup:read- Roles
- admin, scheduler
Fetch a paginated list of certifications, with optional filters including search, sorting, and tenant-specific results.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query string to match against name or ID (based on columns). Example |
columns | string | Comma-separated list of columns to apply search on. E.g., name,certificationBody Example |
certificationName | string | Filter by certification name or ID. Accepts both numeric and string inputs. Example |
certificationId | integer | Filter by specific certification ID. Example |
certificationBody | string | Filter certifications by their certification body ID or name. Example |
requirement | string | Filter by requirement type (e.g., required, optional). One of: |
expirationRequired | boolean | Filter certifications based on whether expiration date is required. Example |
uploadRequired | boolean | Filter certifications based on whether document upload is required. Example |
sortBy | string | Column to sort by. Default |
sortOrder | string | Sort order direction (asc or desc). One of: |
perPage | integer | Number of results per page. Default |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/certifications" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Certifications retrieved successfully
Certifications retrieved successfully
{
"success": true,
"meta": {
"currentPage": 1,
"lastPage": 5,
"perPage": 10,
"total": 50
},
"data": [
{
"id": 1,
"name": "Example name",
"certificationBody": 1,
"certificationBodyName": "Example name",
"level": 1,
"requirement": "preferred",
"expirationRequired": true,
"uploadRequired": true
}
]
}Response fields (15)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
meta | object | |
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
data | array of object | |
data[].id | integer | Example |
data[].name | string | Example |
data[].certificationBody | integer or null | Example |
data[].certificationBodyName | string or null | Example |
data[].level | integer or null | Example |
data[].requirement | string or null | Example |
data[].expirationRequired | boolean | Example |
data[].uploadRequired | boolean | Example |
400 Bad request
Invalid request (e.g. bad input type)
{
"success": false,
"message": "Failed to retrieve.",
"errors": "Error fetching certifications: SQLSTATE[22P02]..."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | 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!",
"errors": "An unexpected error occurred."
}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 |