DAdatadog
On-Call

List On-Call schedules

Retrieve a list of On-Call schedules.

get/api/v2/on-call/schedules

Request

Query parameters

page[size]integer
Example:10

Number of items to return per page. The maximum allowed value is 100.

page[number]integer

Specific page number to return.

filter[query]string

Search query to filter schedules. Supports free-text search on schedule name (case-insensitive, * wildcards), and structured filters such as team.id:<uuid> and user.id:<uuid> (multiple values can be combined with OR, e.g. user.id:(<uuid> OR <uuid>)).

includestring

Comma-separated list of included relationships to be returned. Allowed value: teams.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "max_responders": 1,
        "name": "Primary On-Call",
        "tags": [],
        "time_zone": "America/New_York"
      },
      "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
      "relationships": {
        "teams": {
          "data": [
            {
              "id": "00000000-da3a-0000-0000-000000000000",
              "type": "teams"
            }
          ]
        }
      },
      "type": "schedules"
    }
  ],
  "meta": {
    "page": {
      "first_number": 0,
      "last_number": 0,
      "next_number": null,
      "number": 0,
      "prev_number": null,
      "size": 10,
      "total": 1,
      "type": "number_size"
    }
  }
}

Changes

Changes to this operation have not been checked yet.