Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
On-Call

Get scheduled on-call user

Retrieves the user who is on-call for the specified schedule at a given time.

get/api/v2/on-call/schedules/{schedule_id}/on-call

Path parameters

schedule_idstring required
Example:3653d3c6-0c75-11ea-ad28-fb5701eabc7d

The ID of the schedule.

Query parameters

includestring

Specifies related resources to include in the response as a comma-separated list. Allowed value: user.

filter[at_ts]string
Example:2025-05-07T02:53:01Z

Retrieves the on-call user at the given timestamp in RFC3339 format (for example, 2025-05-07T02:53:01Z or 2025-05-07T02:53:01+00:00). When using timezone offsets with + or -, ensure proper URL encoding (+ should be encoded as %2B). Defaults to the current time if omitted.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "end": "2025-05-07T03:53:01.206662873Z",
      "start": "2025-05-07T02:53:01.206662814Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "relationships": {
      "user": {
        "data": {
          "id": "00000000-aba1-0000-0000-000000000000",
          "type": "users"
        }
      }
    },
    "type": "shifts"
  },
  "included": [
    {
      "attributes": {
        "email": "foo@bar.com",
        "name": "User 1",
        "status": ""
      },
      "id": "00000000-aba1-0000-0000-000000000000",
      "type": "users"
    }
  ]
}