Schedule

List Schedules

get

/v4/schedules

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

teamIDstringRequired

scheduleIDsinteger[]Optional

participantsstring[]Optional

scheduleNamestringOptional

myOnCallbooleanOptional

youAndYourSquadsbooleanOptional

searchstringOptional

hidePausedbooleanOptional

ownerIDstringOptional

escalationPoliciesstring[]Optional

withoutEscalationPolicybooleanOptional

pageSizeintegerOptional

cursorstringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v4/schedules

GET /v4/schedules?teamID=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "orgID": "text",
      "teamID": "text",
      "timeZone": "text",
      "paused": true,
      "ownerID": "text",
      "ownerType": "user",
      "tags": [
        {
          "key": "text",
          "value": "text",
          "color": "text"
        }
      ],
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "pageInfo": {
    "pageSize": 1,
    "hasNext": true,
    "hasPrev": true,
    "nextCursor": "text",
    "prevCursor": "text"
  }
}

Create Schedule

post

/v4/schedules

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequired

descriptionstringRequired

teamIDstringRequired

ownerIDstringRequired

ownerTypestring · enumRequiredPossible values:

timeZonestringRequired

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post/v4/schedules

POST /v4/schedules HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "name": "text",
  "description": "text",
  "teamID": "text",
  "ownerID": "text",
  "ownerType": "user",
  "timeZone": "text",
  "tags": [
    {
      "key": "text",
      "value": "text",
      "color": "text"
    }
  ]
}

{
  "data": {
    "id": 1,
    "name": "text",
    "description": "text",
    "orgID": "text",
    "teamID": "text",
    "timeZone": "text",
    "paused": true,
    "ownerID": "text",
    "ownerType": "user",
    "tags": [
      {
        "key": "text",
        "value": "text",
        "color": "text"
      }
    ],
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Get Schedule by ID

get

/v4/schedules/{scheduleID}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v4/schedules/{scheduleID}

GET /v4/schedules/{scheduleID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "description": "text",
    "orgID": "text",
    "teamID": "text",
    "timeZone": "text",
    "paused": true,
    "ownerID": "text",
    "ownerType": "user",
    "tags": [
      {
        "key": "text",
        "value": "text",
        "color": "text"
      }
    ],
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Update Schedule

put

/v4/schedules/{scheduleID}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Body

namestringRequired

descriptionstringRequired

ownerIDstringRequired

ownerTypestring · enumRequiredPossible values:

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put/v4/schedules/{scheduleID}

PUT /v4/schedules/{scheduleID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "name": "text",
  "description": "text",
  "ownerID": "text",
  "ownerType": "user",
  "tags": [
    {
      "key": "text",
      "value": "text",
      "color": "text"
    }
  ]
}

{
  "data": {
    "id": 1,
    "name": "text",
    "description": "text",
    "orgID": "text",
    "teamID": "text",
    "timeZone": "text",
    "paused": true,
    "ownerID": "text",
    "ownerType": "user",
    "tags": [
      {
        "key": "text",
        "value": "text",
        "color": "text"
      }
    ],
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Delete Schedule

delete

/v4/schedules/{scheduleID}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

objectOptional

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete/v4/schedules/{scheduleID}

DELETE /v4/schedules/{scheduleID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Pause/Resume Schedule

patch

/v4/schedules/{scheduleID}/actions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Body

actionstring · enumOptionalPossible values:

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch/v4/schedules/{scheduleID}/actions

PATCH /v4/schedules/{scheduleID}/actions HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "action": "pause"
}

{
  "data": {
    "action": "text",
    "success": true
  }
}

Change Timezone

patch

/v4/schedules/{scheduleID}/change-timezone

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Body

timeZonestringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch/v4/schedules/{scheduleID}/change-timezone

PATCH /v4/schedules/{scheduleID}/change-timezone HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "timeZone": "text"
}

{
  "data": {
    "timeZone": "text"
  }
}

Clone Schedule

post

/v4/schedules/{scheduleID}/clone

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Body

objectOptional

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post/v4/schedules/{scheduleID}/clone

POST /v4/schedules/{scheduleID}/clone HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "data": {
    "id": 1,
    "name": "text",
    "description": "text",
    "orgID": "text",
    "teamID": "text",
    "timeZone": "text",
    "paused": true,
    "ownerID": "text",
    "ownerType": "user",
    "tags": [
      {
        "key": "text",
        "value": "text",
        "color": "text"
      }
    ],
    "createdAt": "text",
    "updatedAt": "text"
  }
}

PreviousWorkflows NextSchedule/Export Schedule

Last updated 5 days ago