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
| Name | Type | Description |
|---|---|---|
tab required | string | Tab name to fetch data for. One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].id | integer | Example |
data[].name | string | Example |
data[].isCustom | boolean | Example |
data[].certifications | array of integer | |
data[].certificationsName | array of string | |
data[].serviceProviderType | array of integer | |
data[].serviceProviderTypeName | array of string |
400 Bad request
Invalid tab name passed
{
"success": false,
"message": "Invalid tab.",
"errors": "The selected tab is not supported."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string | 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_service_setup: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 |
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
Unexpected server error
{
"success": false,
"message": "Service setup view failed: Undefined variable or query issue.",
"errors": "An unexpected error occurred — please try again."
}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 |