API reference › Rates and billing › Service type rates
Get service type rate by ID
GET /v1/settings/service-type-rates/{service_type_rate}
- Scope
settings_rates_billing:read finance:read- Roles
- admin, scheduler
Retrieves a single service type rate by its ID. 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
Path parameters
| Name | Type | Description |
|---|---|---|
service_type_rate required | integer | Unique identifier of the service type rate Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/service-type-rates/{service_type_rate}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Service type rate retrieved successfully
Service type rate retrieved successfully.
{
"success": true,
"data": {
"id": 1,
"rateType": {
"id": 1,
"label": "Example label"
},
"serviceType": {
"id": 1,
"label": "Example label"
},
"serviceProviderType": {
"id": 1,
"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
}
}Response fields (27)
2 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | object (25 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 | string | 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 | string | Example |
data.specialization.label | string | Example |
data.unit | string | Example |
data.rate | integer | Example |
data.minimumDuration | integer | Example |
data.assignment | boolean | Example |
data.shift | boolean | Example |
data.disabledDelete | boolean | Example |
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 |
404 Not found
Service type rate not found
{
"success": false,
"message": "Service type rate not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
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
Internal server error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |