Rotation Schedules

List rotation schedules

Changed on

Endpoint used to list rotation schedule resources

get/rotationschedules

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Rotation Schedules returned

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Rotation Schedules list

nextCursorstring nullable required

The cursor to retrieve the next page of Rotation Schedules.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Rotation Schedules.

Example response

{
  "rotationSchedules": [
    {
      "id": 963,
      "organizationId": 1,
      "name": "Team A - 4 on / 3 off",
      "startDate": "2022-01-01T00:00:00.000Z",
      "days": [
        {
          "dayType": "WORKING",
          "seconds": 28800
        }
      ],
      "sourceTemplatePattern": "pitman",
      "assignedUsersCount": 3,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "archivedAt": "2022-01-01T00:00:00.000Z"
    }
  ]
}

Changes