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

NameTypeDescription
tenantIdstring

Tenant ID. Used for multi-tenant authentication.

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

Example request

Shell
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

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

FieldTypeDescription
successboolean

Example true.

messagestring

Example Requirement preferences Retrieved!.

dataobject (29 nested)

Nested fields

data 29 fields
FieldTypeDescription
data.skillsarray of object
data.skills[].idinteger

Example 1.

data.skills[].valueinteger

Example 1.

data.skills[].labelstring

Example Basic.

data.skills[].isCustomboolean

Example false.

data.certificationsarray of object
data.certifications[].idinteger

Example 1.

data.certifications[].valueinteger

Example 1.

data.certifications[].labelstring

Example RID.

data.certifications[].isCustomboolean

Example false.

data.clearancesarray of object
data.clearances[].idinteger

Example 1.

data.clearances[].valueinteger

Example 1.

data.clearances[].labelstring

Example HIPAA.

data.clearances[].isCustomboolean

Example false.

data.insurancesarray of object

The organization's insurance list (Settings → Service Setup → Insurance). Empty without tenantId: there is no central catalog.

data.insurances[].idinteger

Example 1.

data.insurances[].valueinteger

Example 1.

data.insurances[].labelstring

Example General Liability.

data.insurances[].isCustomboolean or null
data.insurances[].serviceIdinteger

The service type the entry is for.

Example 1.

data.insurances[].serviceProviderTypeIdinteger

The service provider type the entry is for.

Example 2.

data.insurances[].uploadRequiredboolean

Example true.

data.insurances[].expireDateRequiredboolean

Example true.

data.specializationsarray of object
data.specializations[].idinteger

Example 1.

data.specializations[].valueinteger

Example 1.

data.specializations[].labelstring

Example Legal.

data.specializations[].isCustomboolean

Example false.

400 Bad request

Invalid argument provided

JSON
{
  "success": false,
  "message": "Failed to retrieve."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

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

Internal server error

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.