API reference › Rates and billing › Provider portal

Retrieve paginated assignment rates list with optional filters

GET /v1/settings/portal/provider/rates-billing/{tab}

Scope
settings_rates_billing:read
Roles
service-provider

Fetch a paginated list of assignment rates list entries. Allows filtering, searching, and sorting.

Parameters

Path parameters

NameTypeDescription
tab requiredstring

Identifier for the specific tab to fetch (e.g., 'rates', 'network_rates')

One of: rates, network_rates. Example rates.

Query parameters

NameTypeDescription
searchstring

Search keyword

columnsstring

Comma-separated list of searchable columns

sortBystring

Column to sort by

sortOrderstring

Sort order

One of: asc, desc.

perPageinteger

Items per page

siteTypestring

Filter by site ID

serviceTypestring

Filter by service ID

providerTypestring

Filter by service provider ID

serviceRatestring

Filter by rate ID

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/settings/portal/provider/rates-billing/{tab}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Success

Success

JSON
{
  "success": true,
  "message": "Rates & billing details retrieved.",
  "data": [
    {
      "id": 1,
      "rateType": {
        "id": 2,
        "label": "After Hours"
      },
      "serviceType": {
        "id": 2,
        "label": "CART"
      },
      "serviceProviderType": {
        "id": 2,
        "label": "Hearing"
      },
      "certification": {
        "id": 7,
        "label": "BEI DI"
      },
      "siteType": {
        "id": "remote",
        "label": "Remote"
      },
      "specialization": {
        "id": 1,
        "label": "Legal"
      },
      "unit": "hour",
      "rate": 0,
      "minimumDuration": 1,
      "assignment": true,
      "shift": true,
      "disabledDelete": true
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 1
  }
}
Response fields (33)

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

FieldTypeDescription
successboolean

Example true.

messagestring

Example Rates & billing details retrieved..

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

Nested fields

data 25 fields
FieldTypeDescription
data[].idinteger

Example 1.

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

Example 2.

data[].rateType.labelstring

Example After Hours.

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

Example 2.

data[].serviceType.labelstring

Example CART.

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

Example 2.

data[].serviceProviderType.labelstring

Example Hearing.

data[].certificationobject
data[].certification.idinteger

Example 7.

data[].certification.labelstring

Example BEI DI.

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

Example remote.

data[].siteType.labelstring

Example Remote.

data[].specializationobject
data[].specialization.idinteger

Example 1.

data[].specialization.labelstring

Example Legal.

data[].unitstring or null

Example hour.

data[].ratenumber

Example 0.

data[].minimumDurationinteger or null

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

meta.perPageinteger

Example 10.

meta.totalinteger

Example 1.

400 Bad request

Bad Request

JSON
{
  "success": false,
  "message": "Failed to retrieve.",
  "errors": {
    "search": [
      "Invalid search parameter"
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to retrieve..

errorsobject
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_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 .

422 Validation failed

Unknown tab.

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": {
    "tab": [
      "The selected tab is invalid. Valid options are: rates, network_rates."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsobject
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

Server Error

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Unexpected error occurred"
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

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

Example Unexpected error occurred.