API reference › General settings › Ethnicities

Retrieve paginated ethnicities with optional filters

GET /v1/ethnicities

Scope
settings_general:read
Roles
admin, scheduler

Fetch a paginated list of ethnicities. 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

NameTypeDescription
searchstring

Global search term across selected columns

Example Asian.

columnsstring

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

Example name.

sortBystring

Field to sort by (defaults to id)

Example name.

sortOrderstring

Sorting order (asc or desc, defaults to desc)

One of: asc, desc. Example asc.

perPageinteger

Number of items per page

Example 10.

pageinteger

Page number

Example 1.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl "https://api.fetchfido.ai/v1/ethnicities" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Ethnicities retrieved successfully

Ethnicities retrieved successfully.

JSON
{
  "success": true,
  "data": [
    {
      "id": 1,
      "value": 1,
      "label": "Asian",
      "isCustom": false
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 9
  }
}
Response fields (11)
FieldTypeDescription
successboolean

Example true.

dataarray of object
data[].idinteger

Example 1.

data[].valueinteger

Example 1.

data[].labelstring

Example Asian.

data[].isCustomboolean

Example false.

metaobject
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 9.

400 Bad request

The list could not be read.

JSON
{
  "success": false,
  "message": "Failed to retrieve.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

errorsstring or null

The underlying error, in debug mode only.

codestring

Example .

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_general: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_general: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!",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

The underlying error, in debug mode only.

codestring

Example .