API reference › Rates and billing › Provider rates

List provider rates

GET /v1/settings/provider-rates

Scope
settings_rates_billing:read finance:read
Roles
admin, scheduler

Retrieves a paginated list of provider rates with optional filters. Finances data: without Finance Read it answers 200 with an empty page (data [], meta.total 0) and the reason in message, whatever the role holds on Rates & Billing.

Parameters

Query parameters

NameTypeDescription
searchstring

Search term to filter rates by service type, provider type, certification, or specialization

Example ASL.

startDatestring (date)

Start date for filtering rates (format: YYYY-MM-DD)

Example 2023-01-01.

endDatestring (date)

End date for filtering rates (format: YYYY-MM-DD)

Example 2023-12-31.

sortBystring

Field to sort by (e.g., 'rate', 'serviceType', 'providerRole')

Example rate.

sortOrderstring

Sort order (asc or desc)

Example asc.

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/provider-rates" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Provider rates retrieved successfully

Provider rates retrieved successfully.

JSON
{
  "success": true,
  "data": [
    {
      "id": 1,
      "rateType": {
        "id": 1,
        "label": "Example label"
      },
      "serviceType": {
        "id": 1,
        "label": "Example label"
      },
      "serviceProviderType": {
        "id": 1,
        "label": "Example label"
      },
      "providerRole": {
        "id": "string",
        "label": "Example label"
      },
      "certification": {
        "id": "USR-LBW3CV",
        "label": "Example label"
      },
      "siteType": {
        "id": "string",
        "label": "Example label"
      },
      "specialization": {
        "id": "USR-LBW3CV",
        "label": "Example label"
      },
      "unit": "hour",
      "rate": 0,
      "minimumDuration": 1,
      "assignment": true,
      "shift": true,
      "disabledDelete": true
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 5,
    "perPage": 10,
    "total": 50
  }
}
Response fields (35)

3 top-level fields; 2 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

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

Nested fields

data 28 fields
FieldTypeDescription
data[].idinteger

Example 1.

data[].rateTypeobject
data[].rateType.idinteger

Example 1.

data[].rateType.labelstring

Example Example label.

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

Example 1.

data[].serviceType.labelstring

Example Example label.

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

Example 1.

data[].serviceProviderType.labelstring

Example Example label.

data[].providerRoleobject
data[].providerRole.idstring

Example string.

data[].providerRole.labelstring

Example Example label.

data[].certificationobject
data[].certification.idstring

Example USR-LBW3CV.

data[].certification.labelstring

Example Example label.

data[].siteTypeobject
data[].siteType.idstring

Example string.

data[].siteType.labelstring

Example Example label.

data[].specializationobject
data[].specialization.idstring

Example USR-LBW3CV.

data[].specialization.labelstring

Example Example label.

data[].unitstring

Example hour.

data[].rateinteger

Example 0.

data[].minimumDurationinteger

Example 1.

data[].assignmentboolean

Example true.

data[].shiftboolean

Example true.

data[].disabledDeleteboolean

Example true.

meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 5.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 50.

401 Not signed in

Unauthorized - Authentication required

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_rates_billing: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_rates_billing: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": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..