API reference › General settings › Requirements and preferences
Get paginated client requirements
GET /v1/settings/portal/client-portal/requirements
- Scope
settings_general:read- Roles
- client
Returns a paginated list of client requirements with related service types, skills, certifications, etc.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
sortBy | string | Field to sort by Example |
sortOrder | string | Sort order: asc or desc Example |
perPage | integer | Number of items per page Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/portal/client-portal/requirements" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Paginated list of client requirements
Paginated list of client requirements
{
"success": true,
"data": [
{
"id": 1,
"isDefault": true,
"serviceType": {
"id": 1,
"label": "ASL"
},
"serviceProviderType": {
"id": 1,
"label": "Deaf"
},
"certification": [
{
"id": 1,
"label": "NIC"
}
],
"skill": {
"id": 2,
"label": "Advanced"
},
"clearance": [
{
"id": 1,
"label": "HIPPA"
}
],
"specialization": [
{
"id": 1,
"label": "Legal"
}
],
"gender": {
"id": "male",
"value": "male",
"label": "Male"
},
"location": "string"
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 1
}
}Response fields (32)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (25 nested) | |
meta | object (4 nested) |
Nested fields
data 25 fields
| Field | Type | Description |
|---|---|---|
data[].id | integer | Example |
data[].isDefault | boolean | Example |
data[].serviceType | object | |
data[].serviceType.id | integer | Example |
data[].serviceType.label | string | Example |
data[].serviceProviderType | object | |
data[].serviceProviderType.id | integer | Example |
data[].serviceProviderType.label | string | Example |
data[].certification | array of object | |
data[].certification[].id | integer | Example |
data[].certification[].label | string | Example |
data[].skill | object | |
data[].skill.id | integer | Example |
data[].skill.label | string | Example |
data[].clearance | array of object | |
data[].clearance[].id | integer | Example |
data[].clearance[].label | string | Example |
data[].specialization | array of object | |
data[].specialization[].id | integer | Example |
data[].specialization[].label | string | Example |
data[].gender | object | |
data[].gender.id | string | Example |
data[].gender.value | string | Example |
data[].gender.label | string | Example |
data[].location | string or null |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | 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
Unexpected error
{
"success": false,
"message": "An unexpected error occurred — please try again.",
"errors": "Detailed error message"
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |