API reference › Service setup › Insurances

Retrieve all insurances or filter by tenant ID

GET /v1/insurances

Scope
settings_service_setup:read
Roles
admin, scheduler

Fetch a paginated list of insurances with search, filters, sorting and pagination. Each row carries the service type and service provider type it is for.

Parameters

Query parameters

NameTypeDescription
searchstring

Matches the start of any word in the insurance name, its service type name or its service provider type name, in any case.

Example Liability.

columnsstring

Comma-separated list of columns to apply search on (e.g., name).

Example name.

insuranceIdinteger

Filter by specific insurance ID.

Example 1.

serviceTypeinteger

Filter by service type ID.

Example 1.

serviceProviderTypeinteger

Filter by service provider type ID.

Example 2.

requirementstring

Filter by requirement level.

One of: required, preferred, optional. Example preferred.

expirationRequiredboolean

Filter insurances based on whether expiration is required.

Example true.

uploadRequiredboolean

Filter insurances based on whether document upload is required.

Example true.

sortBystring

Field to sort by: name, serviceType, serviceProviderType, requirement, expirationRequired, uploadRequired or a column name. Defaults to id.

Example name.

sortOrderstring

Sort order: asc or desc (the default; anything other than asc reads as desc).

One of: asc, desc. Example asc.

perPageinteger

Number of results per page.

Example 10.

pageinteger

Page number.

Example 1.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/insurances" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Insurances retrieved successfully

Insurances retrieved successfully.

JSON
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "General Liability",
      "serviceType": {
        "id": 1,
        "label": "ASL"
      },
      "serviceProviderType": {
        "id": 2,
        "label": "Hearing Interpreter"
      },
      "requirement": "preferred",
      "expirationRequired": true,
      "uploadRequired": true
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 1
  }
}
Response fields (18)
FieldTypeDescription
successboolean

Example true.

dataarray of object
data[].idinteger

Example 1.

data[].namestring

Example General Liability.

data[].serviceTypeobject or null
data[].serviceType.idinteger

Example 1.

data[].serviceType.labelstring

Example ASL.

data[].serviceProviderTypeobject or null
data[].serviceProviderType.idinteger

Example 2.

data[].serviceProviderType.labelstring

Example Hearing Interpreter.

data[].requirementstring

Example preferred.

data[].expirationRequiredboolean

Example true.

data[].uploadRequiredboolean

Example true.

metaobject
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 1.

400 Bad request

An unknown sort column or a non-numeric id filter.

JSON
{
  "success": false,
  "message": "Failed to retrieve.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

errorsstring or null

The underlying error, in debug mode only.

codestring

Example .

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_service_setup: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_service_setup: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!.