API reference › Service setup › Insurances

Retrieve a specific insurance by ID

GET /v1/insurances/{insurance}

Scope
settings_service_setup:read
Roles
admin, scheduler

Fetch a single insurance record by its ID, in the shape the edit dialog reads.

Parameters

Path parameters

NameTypeDescription
insurance requiredinteger

ID of the insurance to retrieve.

Example 3.

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

Example request

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

Try it

Responses

200 Insurance retrieved successfully

Insurance retrieved successfully.

JSON
{
  "success": true,
  "message": "Insurance Retrieved!",
  "data": {
    "id": 3,
    "name": {
      "id": 3,
      "label": "General Liability"
    },
    "isCustom": null,
    "serviceType": {
      "id": 1,
      "label": "ASL"
    },
    "serviceProviderType": {
      "id": 2,
      "label": "Hearing Interpreter"
    },
    "requirement": "preferred",
    "expirationRequired": true,
    "uploadRequired": true
  }
}
Response fields (17)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Insurance Retrieved!.

dataobject
data.idinteger

Example 3.

data.nameobject
data.name.idinteger

Example 3.

data.name.labelstring

Example General Liability.

data.isCustomboolean or null
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.

400 Bad request

Insurance not found (unknown or deleted).

JSON
{
  "success": false,
  "message": "Insurance with ID 3 not found.",
  "errors": "Failed to retrieve.",
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Insurance with ID 3 not found..

errorsstring

Example Failed to retrieve..

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