API reference › General settings › Identities
Retrieve paginated identities with optional filters
GET /v1/identities
- Scope
settings_general:read- Roles
- admin, scheduler
Fetch a paginated list of identities. Allows search and sorting. Supports multi-tenancy via X-TENANT-ID header. isCustom is false for the default entries, which can't be renamed or deleted.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Global search term across selected columns Example |
columns | string | Comma-separated list of columns to search (e.g., name) Example |
sortBy | string | Field to sort by (defaults to id) Example |
sortOrder | string | Sorting order (asc or desc, defaults to desc) One of: |
perPage | integer | Number of items per page Example |
page | integer | Page number Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/identities" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Identities retrieved successfully
Identities retrieved successfully.
{
"success": true,
"data": [
{
"id": 1,
"value": 1,
"label": "Veteran",
"isCustom": false
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 7
}
}Response fields (11)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object | |
data[].id | integer | Example |
data[].value | integer | Example |
data[].label | string | Example |
data[].isCustom | boolean | Example |
meta | object | |
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
The list could not be read.
{
"success": false,
"message": "Failed to retrieve.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | The underlying error, in debug mode only. |
code | 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_general: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": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | The underlying error, in debug mode only. |
code | string | Example |