API reference › Schedule › Assignments and shifts on the schedule
Get schedule assignments or shifts with availability matching
POST /v1/schedule/assignments-and-shifts
- Scope
schedule:read- Roles
- admin, scheduler
Retrieve unfilled assignments or shifts matching location, service types, and provider availability with partial coverage support
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
startDate | string (date) | Example |
endDate | string (date) | Example |
startTime | string (time) | Filter whose scheduled time range overlaps this start time (HH:MM:SS). Pairs with endTime. Example |
endTime | string (time) | Filter whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime. Example |
locationType | string | One of: |
type | string | One of: |
providerId | string | Excludes assignments/shifts this provider is already assigned to Example |
serviceTypes | array of integer | |
availability | array of object | |
availability[].day | string | Example |
availability[].date | string (date) | Example |
availability[].startTime | string | Example |
availability[].endTime | string | Example |
Example
{
"startDate": "2025-11-01",
"endDate": "2025-11-30",
"startTime": "09:00:00",
"endTime": "17:00:00",
"locationType": "onsite",
"type": "assignment",
"providerId": "SP-XDMSDH",
"serviceTypes": [
1,
2,
3
],
"availability": [
{
"day": "Tuesday",
"date": "2025-11-04",
"startTime": "14:00",
"endTime": "16:00"
}
]
}Example request
curl -X POST "https://api.fetchfido.ai/v1/schedule/assignments-and-shifts" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"startDate":"2025-11-01","endDate":"2025-11-30","startTime":"09:00:00","endTime":"17:00:00","locationType":"onsite","type":"assignment","providerId":"SP-XDMSDH","serviceTypes":[1,2,3],"availability":[{"day":"Tuesday","date":"2025-11-04","startTime":"14:00","endTime":"16:00"}]}'Try it
Responses
200 Assignments or shifts retrieved successfully
Assignments or shifts retrieved successfully
{
"success": true,
"message": "Assignments retrieved successfully",
"data": [
{
"id": "ASG-XDMSDH",
"label": "Home Care Assignment",
"startDate": "2025-11-01",
"endDate": "2025-11-30"
}
]
}Response fields (7)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].id | string | Example |
data[].label | string | Example |
data[].startDate | string | Example |
data[].endDate | 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 'schedule: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
{
"success": false,
"message": "Unable to save. Please check the highlighted fields",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Details when the handler has them — a field-keyed object, a single string, or null. |
code | string | Empty unless the handler sets one. 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.",
"errors": null,
"code": ""
}Response fields (4)
| 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, so nothing is leaked to an integrator. |
code | string | Always empty: the server-error response carries no error code. Example |