API reference › Service setup › Service types

Fetch data for a specific service setup tab

GET /v1/service-setup/{tab}

Scope
settings_service_setup:read
Roles
admin, scheduler

Returns data for tabs like service_configuration, certifications, clearances, specialization, and skills for the given tenant.

Parameters

Path parameters

NameTypeDescription
tab requiredstring

Tab name to fetch data for.

One of: service_configuration, certifications, clearances, specialization, skills. Example service_configuration.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/service-setup/{tab}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Service setup data retrieved successfully

Service setup data retrieved successfully.

JSON
{
  "success": true,
  "message": "Service Setup details retrieved!",
  "data": [
    {
      "id": 1,
      "name": "ASL Interpreting",
      "isCustom": false,
      "certifications": [
        3,
        4
      ],
      "certificationsName": [
        "NIC",
        "CDI"
      ],
      "serviceProviderType": [
        1,
        2
      ],
      "serviceProviderTypeName": [
        "Hearing Interpreter",
        "Deaf Interpreter"
      ]
    }
  ]
}
Response fields (10)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service Setup details retrieved!.

dataarray of object
data[].idinteger

Example 1.

data[].namestring

Example ASL Interpreting.

data[].isCustomboolean

Example false.

data[].certificationsarray of integer
data[].certificationsNamearray of string
data[].serviceProviderTypearray of integer
data[].serviceProviderTypeNamearray of string
400 Bad request

Invalid tab name passed

JSON
{
  "success": false,
  "message": "Invalid tab.",
  "errors": "The selected tab is not supported."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid tab..

errorsstring

Example The selected tab is not supported..

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_service_setup: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_service_setup: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

Unexpected server error

JSON
{
  "success": false,
  "message": "Service setup view failed: Undefined variable or query issue.",
  "errors": "An unexpected error occurred — please try again."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Service setup view failed: Undefined variable or query issue..

errorsstring or null

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

Example An unexpected error occurred — please try again..