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

NameTypeDescription
sortBystring

Field to sort by

Example created_at.

sortOrderstring

Sort order: asc or desc

Example desc.

perPageinteger

Number of items per page

Example 10.

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

Example request

Shell
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

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

dataarray of object (25 nested)
metaobject (4 nested)

Nested fields

data 25 fields
FieldTypeDescription
data[].idinteger

Example 1.

data[].isDefaultboolean

Example true.

data[].serviceTypeobject
data[].serviceType.idinteger

Example 1.

data[].serviceType.labelstring

Example ASL.

data[].serviceProviderTypeobject
data[].serviceProviderType.idinteger

Example 1.

data[].serviceProviderType.labelstring

Example Deaf.

data[].certificationarray of object
data[].certification[].idinteger

Example 1.

data[].certification[].labelstring

Example NIC.

data[].skillobject
data[].skill.idinteger

Example 2.

data[].skill.labelstring

Example Advanced.

data[].clearancearray of object
data[].clearance[].idinteger

Example 1.

data[].clearance[].labelstring

Example HIPPA.

data[].specializationarray of object
data[].specialization[].idinteger

Example 1.

data[].specialization[].labelstring

Example Legal.

data[].genderobject
data[].gender.idstring

Example male.

data[].gender.valuestring

Example male.

data[].gender.labelstring

Example Male.

data[].locationstring or null
meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 1.

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

Unexpected error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": "Detailed error message"
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Detailed error message.