Retrieve shift providers
GET /v1/shift/{id}/providers/{serviceType}/{status}
- Scope
shifts:read- Roles
- admin, scheduler
Fetches the shift providers.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Unique identifier of the shift Example |
serviceType required | integer | Identifier for the service type Example |
status required | string | Status of the shift providers One of: |
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter provider by name, method Example |
locationType | string | Limit to providers on this location type. One of: |
page | integer | Page number (default: 1). Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/shift/{id}/providers/{serviceType}/{status}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Shift providers retrieved successfully
Shift providers retrieved successfully
{
"success": true,
"data": [
{
"id": 1,
"method": "string",
"status": "string",
"serviceProviderId": "SPR-FG543C",
"onlineStatus": "online",
"name": "Example name",
"image": "https://cdn.example.com/image.png",
"email": "user@example.com",
"distance": 0,
"slotType": "string",
"slotStartTime": "09:00:00",
"slotEndTime": "09:00:00",
"serviceType": "string",
"serviceProviderType": {
"id": 1,
"label": "Example label"
},
"startDate": "2026-01-15",
"startTime": "09:00:00",
"endDate": "2026-01-15",
"endTime": "09:00:00",
"locationType": "string",
"timezone": "America/New_York",
"verifiedTimeLogs": true,
"isNoShow": true,
"noShowReason": "Client requested a change",
"noShowMarkedAt": "2026-01-15 09:00:00",
"noShowMarkedBy": "string"
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 2
}
}Response fields (34)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (27 nested) | |
meta | object (4 nested) |
Nested fields
data 27 fields
| Field | Type | Description |
|---|---|---|
data[].id | integer | Example |
data[].method | string | Example |
data[].status | string | Example |
data[].serviceProviderId | string | Example |
data[].onlineStatus | string | Example |
data[].name | string | Example |
data[].image | string | Example |
data[].email | string | Example |
data[].distance | integer | Example |
data[].slotType | string | Example |
data[].slotStartTime | string (time) | Example |
data[].slotEndTime | string (time) | Example |
data[].serviceType | string | Example |
data[].serviceProviderType | object | |
data[].serviceProviderType.id | integer | Example |
data[].serviceProviderType.label | string | Example |
data[].startDate | string (date) | Example |
data[].startTime | string (time) | Example |
data[].endDate | string (date) | Example |
data[].endTime | string (time) | Example |
data[].locationType | string | Example |
data[].timezone | string | Example |
data[].verifiedTimeLogs | boolean | Example |
data[].isNoShow | boolean | Example |
data[].noShowReason | string | Example |
data[].noShowMarkedAt | string (date-time) | Example |
data[].noShowMarkedBy | string | Example |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
401 Not signed in
Unauthorized - authentication required
{
"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 'shifts: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
Validation error - Missing or invalid parameters
{
"success": false,
"message": "Validation Failed",
"errors": {
"id": [
"The specified shift does not exist."
]
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.id | array of string |
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 |