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

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.List(ctx, operations.SchedulesListSchedulesRequest{
        TeamID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "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,
    "hasPrevious": true,
    "nextCursor": "text",
    "previousCursor": "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

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.Create(ctx, components.V4CreateScheduleRequest{
        Name: "<value>",
        Description: "fumigate pfft kooky whoa but lighthearted popularity",
        TeamID: "<id>",
        OwnerID: "<id>",
        OwnerType: components.V4CreateScheduleRequestOwnerTypeUser,
        TimeZone: "Pacific/Easter",
        Tags: []components.V4Tag{
            components.V4Tag{
                Key: "<key>",
                Value: "<value>",
                Color: "pink",
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

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

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.GetByID(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

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

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.Update(ctx, "<id>", components.V4UpdateScheduleRequest{
        Name: "<value>",
        Description: "smoothly festival unruly alert now far provided absentmindedly",
        OwnerID: "<id>",
        OwnerType: components.V4UpdateScheduleRequestOwnerTypeSquad,
        Tags: []components.V4Tag{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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.

*/*

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}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.Delete(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

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

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.PauseResume(ctx, "<id>", operations.SchedulesPauseresumeScheduleRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.ChangeTimezone(ctx, "<id>", operations.SchedulesChangeTimezoneRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.Clone(ctx, "<id>", operations.SchedulesCloneScheduleRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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 3 days ago

Good morning

hashtagList Schedules

hashtagCreate Schedule

hashtagGet Schedule by ID

hashtagUpdate Schedule

hashtagDelete Schedule

hashtagPause/Resume Schedule

hashtagChange Timezone

hashtagClone Schedule

List Schedules

Create Schedule

Get Schedule by ID

Update Schedule

Delete Schedule

Pause/Resume Schedule

Change Timezone

Clone Schedule