API reference › General settings › Requirements and preferences
Retrieve a list of requirement preferences
GET /v1/requirement-preferences
- Scope
settings_general:read
Fetch a list of available requirement preferences.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
tenantId | string | Tenant ID. Used for multi-tenant authentication. |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/requirement-preferences" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Requirement preferences retrieved successfully
Requirement preferences retrieved successfully
{
"success": true,
"message": "Requirement preferences Retrieved!",
"data": {
"skills": [
{
"id": 1,
"value": 1,
"label": "Basic",
"isCustom": false
},
{
"id": 2,
"value": 2,
"label": "Advanced",
"isCustom": false
}
],
"certifications": [
{
"id": 1,
"value": 1,
"label": "RID",
"isCustom": false
},
{
"id": 2,
"value": 2,
"label": "NIC",
"isCustom": false
}
],
"clearances": [
{
"id": 1,
"value": 1,
"label": "HIPAA",
"isCustom": false
},
{
"id": 2,
"value": 2,
"label": "Background Check",
"isCustom": false
}
],
"specializations": [
{
"id": 1,
"value": 1,
"label": "Legal",
"isCustom": false
},
{
"id": 2,
"value": 2,
"label": "Medical",
"isCustom": false
}
]
}
}Response fields (32)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (29 nested) |
Nested fields
data 29 fields
| Field | Type | Description |
|---|---|---|
data.skills | array of object | |
data.skills[].id | integer | Example |
data.skills[].value | integer | Example |
data.skills[].label | string | Example |
data.skills[].isCustom | boolean | Example |
data.certifications | array of object | |
data.certifications[].id | integer | Example |
data.certifications[].value | integer | Example |
data.certifications[].label | string | Example |
data.certifications[].isCustom | boolean | Example |
data.clearances | array of object | |
data.clearances[].id | integer | Example |
data.clearances[].value | integer | Example |
data.clearances[].label | string | Example |
data.clearances[].isCustom | boolean | Example |
data.insurances | array of object | The organization's insurance list (Settings → Service Setup → Insurance). Empty without tenantId: there is no central catalog. |
data.insurances[].id | integer | Example |
data.insurances[].value | integer | Example |
data.insurances[].label | string | Example |
data.insurances[].isCustom | boolean or null | |
data.insurances[].serviceId | integer | The service type the entry is for. Example |
data.insurances[].serviceProviderTypeId | integer | The service provider type the entry is for. Example |
data.insurances[].uploadRequired | boolean | Example |
data.insurances[].expireDateRequired | boolean | Example |
data.specializations | array of object | |
data.specializations[].id | integer | Example |
data.specializations[].value | integer | Example |
data.specializations[].label | string | Example |
data.specializations[].isCustom | boolean | Example |
400 Bad request
Invalid argument provided
{
"success": false,
"message": "Failed to retrieve."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | 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!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |