On-Call Scheduling API: Assign and Retrieve Members

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

string

required

The unique identifier of the team member to assign.

string

required

The calendar date for the shift in YYYY-MM-DD format.

string

required

Shift start time in 24-hour HH:MM format.

string

required

Shift end time in 24-hour HH:MM format. Must be after startTime.

Response fields

string

required

Unique identifier for the newly created assignment.

string

required

The user ID that was assigned.

string

required

The scheduled date in YYYY-MM-DD format.

string

required

The shift start time.

string

required

The shift end time.

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"
  }'

const response = await fetch(
  'https://your-api-domain.com/api/v1/assign-member',
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      userId: 'user_abc123',
      date: '2026-03-15',
      startTime: '09:00',
      endTime: '17:00',
    }),
  }
);
const data = await response.json();

import requests

response = requests.post(
    'https://your-api-domain.com/api/v1/assign-member',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
    json={
        'userId': 'user_abc123',
        'date': '2026-03-15',
        'startTime': '09:00',
        'endTime': '17:00',
    },
)
data = response.json()

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

object[]

required

Array of assignment objects.

Show assignment properties

string

required

Unique identifier for the assignment.

string

required

The assigned team member’s user ID.

string

required

Scheduled date in YYYY-MM-DD format.

string

required

Shift start time.

string

required

Shift end time.

curl --request GET \
  --url https://your-api-domain.com/api/v1/get-all-assign \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/get-all-assign',
  {
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);
const data = await response.json();

import requests

response = requests.get(
    'https://your-api-domain.com/api/v1/get-all-assign',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)
data = response.json()

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

string

required

The unique identifier of the assignment to retrieve.

Response fields

string

required

Unique identifier for the assignment.

string

required

The assigned team member’s user ID.

string

required

Scheduled date in YYYY-MM-DD format.

string

required

Shift start time.

string

required

Shift end time.

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'

const response = await fetch(
  'https://your-api-domain.com/api/v1/get-assign/assign_xyz789',
  {
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);
const data = await response.json();

import requests

response = requests.get(
    'https://your-api-domain.com/api/v1/get-assign/assign_xyz789',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)
data = response.json()

Overview

Incidents & Tickets

Intelligence

Operations

Platform

On-Call Scheduling API: Assign and Retrieve Members

Assign a member

Request body

Response fields

List all assignments

Response fields

Get a single assignment

Path parameters

Response fields

​Assign a member

​Request body

​Response fields

​List all assignments

​Response fields

​Get a single assignment

​Path parameters

​Response fields

Assign a member

Request body

Response fields

List all assignments

Response fields

Get a single assignment

Path parameters

Response fields