Skip to main content
The on-call scheduling API lets you programmatically assign team members to coverage windows and query those assignments. Use it to automate schedule generation, integrate with HR systems, or build custom dashboards that surface who is on call at any given moment. All requests require a Bearer token in the Authorization header.

​
Assign a member

The date field follows ISO 8601 format (YYYY-MM-DD). Times are in 24-hour format (HH:MM) and are interpreted in UTC unless your account has a default timezone configured.
POST https://your-api-domain.com/api/v1/assign-member Assigns a single team member to an on-call shift on the given date between startTime and endTime.

​
Request body

​
userId
string
required
The unique identifier of the team member to assign.
​
date
string
required
The calendar date for the shift in YYYY-MM-DD format.
​
startTime
string
required
Shift start time in 24-hour HH:MM format.
​
endTime
string
required
Shift end time in 24-hour HH:MM format. Must be after startTime.

​
Response fields

​
id
string
required
Unique identifier for the newly created assignment.
​
userId
string
required
The user ID that was assigned.
​
date
string
required
The scheduled date in YYYY-MM-DD format.
​
startTime
string
required
The shift start time.
​
endTime
string
required
The shift end time.
​
createdAt
string
required
ISO 8601 timestamp of when the assignment was created.
curl --request POST \
  --url https://your-api-domain.com/api/v1/assign-member \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "user_abc123",
    "date": "2026-03-15",
    "startTime": "09:00",
    "endTime": "17:00"
  }'

​
List all assignments

GET https://your-api-domain.com/api/v1/get-all-assign Returns a list of every on-call assignment in the system, ordered by date descending.

​
Response fields

​
assignments
object[]
required
Array of assignment objects.
curl --request GET \
  --url https://your-api-domain.com/api/v1/get-all-assign \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
Get a single assignment

GET https://your-api-domain.com/api/v1/get-assign/:id Returns the details of a single on-call assignment by its ID.

​
Path parameters

​
id
string
required
The unique identifier of the assignment to retrieve.

​
Response fields

​
id
string
required
Unique identifier for the assignment.
​
userId
string
required
The assigned team member’s user ID.
​
date
string
required
Scheduled date in YYYY-MM-DD format.
​
startTime
string
required
Shift start time.
​
endTime
string
required
Shift end time.
​
createdAt
string
required
ISO 8601 timestamp of when the assignment was created.
curl --request GET \
  --url https://your-api-domain.com/api/v1/get-assign/assign_xyz789 \
  --header 'Authorization: Bearer YOUR_TOKEN'