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

FieldTypeDescription
startDatestring (date)

Example 2025-11-01.

endDatestring (date)

Example 2025-11-30.

startTimestring (time)

Filter whose scheduled time range overlaps this start time (HH:MM:SS). Pairs with endTime.

Example 09:00:00.

endTimestring (time)

Filter whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime.

Example 17:00:00.

locationTypestring

One of: remote, onsite, hybrid. Example onsite.

typestring

One of: assignment, shift. Example assignment.

providerIdstring

Excludes assignments/shifts this provider is already assigned to

Example SP-XDMSDH.

serviceTypesarray of integer
availabilityarray of object
availability[].daystring

Example Tuesday.

availability[].datestring (date)

Example 2025-11-04.

availability[].startTimestring

Example 14:00.

availability[].endTimestring

Example 16:00.

Example

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

Shell
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

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignments retrieved successfully.

dataarray of object
data[].idstring

Example ASG-XDMSDH.

data[].labelstring

Example Home Care Assignment.

data[].startDatestring

Example 2025-11-01.

data[].endDatestring

Example 2025-11-30.

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 'schedule: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 'schedule:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

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

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsstring or null

Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator.

codestring

Always empty: the server-error response carries no error code.

Example .