API reference › General settings › Ethnicities

Retrieve an ethnicity by ID

GET /v1/ethnicities/{ethnicity}

Scope
settings_general:read
Roles
admin, scheduler

Fetch an ethnicity by its ID.

Parameters

Path parameters

NameTypeDescription
ethnicity requiredinteger

ID of the ethnicity to retrieve.

Example 3.

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

Example request

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

Try it

Responses

200 Ethnicity retrieved successfully

Ethnicity retrieved successfully.

JSON
{
  "success": true,
  "message": "Ethnicity retrieved successfully!",
  "data": {
    "id": 3,
    "value": 3,
    "label": "Asian",
    "isCustom": false
  }
}
Response fields (7)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Ethnicity retrieved successfully!.

dataobject
data.idinteger

Example 3.

data.valueinteger

Example 3.

data.labelstring

Example Asian.

data.isCustomboolean

Example false.

400 Bad request

No active entry with that id.

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

Example false.

messagestring

Example Ethnicity not found..

errorsstring

Example Failed to retrieve..

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 .

404 Not found

The id is not a number (the route only matches numeric ids).

JSON
{
  "success": false,
  "message": "The route api/v1/ethnicities/abc could not be found.",
  "errors": "string",
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The route api/v1/ethnicities/abc could not be found..

errorsstring or null
codestring

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 .