API reference › General settings › Requirements and preferences
List the organization's requirements and preferences
GET /v1/settings/list-requirements
- Scope
settings_general:read- Roles
- admin, scheduler
Returns the organization-level requirement and preference rows — the top tier that client and consumer rows override. See also /v1/requirement-preferences for the flattened lookup lists.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
populate | boolean | When true, every row reports disabledDelete as false — used when seeding a form from these rows rather than editing them in place. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/list-requirements" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Requirements and preferences retrieved
Requirements and preferences retrieved.
{
"success": true,
"message": "Requirement and Preference Retrieved!",
"data": {
"customizeRequirementPreferences": true,
"requirementAndPreferences": [
{
"id": 5,
"isDefault": false,
"serviceType": {
"id": 1,
"label": "Example"
},
"serviceProviderType": {
"id": 1,
"label": "Example"
},
"skill": {
"id": 1,
"label": "Example"
},
"gender": {
"id": "no_preference",
"value": "no_preference",
"label": "No Preference"
},
"certification": [
{
"id": 1,
"label": "Example"
}
],
"clearance": [
{
"id": 1,
"label": "Example"
}
],
"specialization": [
{
"id": 1,
"label": "Example"
}
],
"disabledDelete": false
}
]
}
}Response fields (30)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (27 nested) |
Nested fields
data 27 fields
| Field | Type | Description |
|---|---|---|
data.customizeRequirementPreferences | boolean | Whether the organization keeps per-service-type rows rather than one default row. Example |
data.requirementAndPreferences | array of object | |
data.requirementAndPreferences[].id | integer | Example |
data.requirementAndPreferences[].isDefault | boolean | Example |
data.requirementAndPreferences[].serviceType | object | |
data.requirementAndPreferences[].serviceType.id | integer or string | Example |
data.requirementAndPreferences[].serviceType.label | string or null | Example |
data.requirementAndPreferences[].serviceProviderType | object | |
data.requirementAndPreferences[].serviceProviderType.id | integer or string | Example |
data.requirementAndPreferences[].serviceProviderType.label | string or null | Example |
data.requirementAndPreferences[].skill | object or null | |
data.requirementAndPreferences[].skill.id | integer or string | Example |
data.requirementAndPreferences[].skill.label | string or null | Example |
data.requirementAndPreferences[].gender | object or null | |
data.requirementAndPreferences[].gender.id | string or null | Example |
data.requirementAndPreferences[].gender.value | string or null | Example |
data.requirementAndPreferences[].gender.label | string or null | Example |
data.requirementAndPreferences[].certification | array of object | |
data.requirementAndPreferences[].certification[].id | integer or string | Example |
data.requirementAndPreferences[].certification[].label | string or null | Example |
data.requirementAndPreferences[].clearance | array of object | |
data.requirementAndPreferences[].clearance[].id | integer or string | Example |
data.requirementAndPreferences[].clearance[].label | string or null | Example |
data.requirementAndPreferences[].specialization | array of object | |
data.requirementAndPreferences[].specialization[].id | integer or string | Example |
data.requirementAndPreferences[].specialization[].label | string or null | Example |
data.requirementAndPreferences[].disabledDelete | boolean | True when the row's provider role is still in use and cannot be removed. Example |
400 Bad request
Failed to retrieve.
{
"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
Server error.
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |