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
| Name | Type | Description |
|---|---|---|
tab required | string | Identifier for the specific tab to fetch (e.g., 'rates', 'network_rates') One of: |
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search keyword |
columns | string | Comma-separated list of searchable columns |
sortBy | string | Column to sort by |
sortOrder | string | Sort order One of: |
perPage | integer | Items per page |
siteType | string | Filter by site ID |
serviceType | string | Filter by service ID |
providerType | string | Filter by service provider ID |
serviceRate | string | Filter by rate ID |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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
{
"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.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object (25 nested) | |
meta | object (4 nested) |
Nested fields
data 25 fields
| Field | Type | Description |
|---|---|---|
data[].id | integer | Example |
data[].rateType | object | |
data[].rateType.id | integer | Example |
data[].rateType.label | string | Example |
data[].serviceType | object | |
data[].serviceType.id | integer | Example |
data[].serviceType.label | string | Example |
data[].serviceProviderType | object | |
data[].serviceProviderType.id | integer | Example |
data[].serviceProviderType.label | string | Example |
data[].certification | object | |
data[].certification.id | integer | Example |
data[].certification.label | string | Example |
data[].siteType | object | |
data[].siteType.id | string | Example |
data[].siteType.label | string | Example |
data[].specialization | object | |
data[].specialization.id | integer | Example |
data[].specialization.label | string | Example |
data[].unit | string or null | Example |
data[].rate | number | Example |
data[].minimumDuration | integer or null | Example |
data[].assignment | boolean | Example |
data[].shift | boolean | Example |
data[].disabledDelete | boolean | Example |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Bad Request
{
"success": false,
"message": "Failed to retrieve.",
"errors": {
"search": [
"Invalid search parameter"
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
422 Validation failed
Unknown tab.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Server Error
{
"success": false,
"message": "Something went wrong!",
"errors": "Unexpected error occurred"
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |