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

NameTypeDescription
service_type_rate requiredinteger

Unique identifier of the service type rate

Example 1.

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

Example request

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

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

dataobject (25 nested)

Nested fields

data 25 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.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.

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 .

404 Not found

Service type rate not found

JSON
{
  "success": false,
  "message": "Service type rate not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Service type rate not found..

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