Teams

Get All Teams

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams

Returns all the teams of the organization. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

/v3/teams

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.GetAll(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "id": "text",
      "created_at": "text",
      "updated_at": "text",
      "created_by": "text",
      "organization_id": "text",
      "name": "text",
      "description": "text",
      "slug": "text",
      "members": [
        {
          "user_id": "text",
          "role": "text",
          "role_ids": [
            "text"
          ],
          "abilities": {
            "escalation_policies": {
              "create-escalation-policies": true,
              "read-escalation-policies": true,
              "update-escalation-policies": true,
              "delete-escalation-policies": true
            },
            "schedules": {
              "create-schedules": true,
              "read-schedules": true,
              "update-schedules": true,
              "delete-schedules": true
            },
            "services": {
              "create-services": true,
              "read-services": true,
              "update-services": true,
              "delete-services": true
            },
            "squads": {
              "create-squads": true,
              "read-squads": true,
              "update-squads": true,
              "delete-squads": true
            },
            "stakeholder_groups": {
              "create-stakeholder-groups": true,
              "read-stakeholder-groups": true,
              "update-stakeholder-groups": true,
              "delete-stakeholder-groups": true
            },
            "runbooks": {
              "create-runbooks": true,
              "read-runbooks": true,
              "update-runbooks": true,
              "delete-runbooks": true
            },
            "postmortems": {
              "create-postmortems": true,
              "read-postmortems": true,
              "update-postmortems": true,
              "delete-postmortems": true
            },
            "status_pages": {
              "create-status-pages": true,
              "read-status-pages": true,
              "update-status-pages": true,
              "delete-status-pages": true
            },
            "team_analytics": {
              "read-team-analytics": true
            },
            "slos": {
              "create-slos": true,
              "read-slos": true,
              "update-slos": true,
              "delete-slos": true
            },
            "webforms": {
              "create-webforms": true,
              "read-webforms": true,
              "update-webforms": true,
              "delete-webforms": true
            },
            "workflows": {
              "create-workflows": true,
              "read-workflows": true,
              "update-workflows": true,
              "delete-workflows": true
            },
            "ger": {
              "create-ger": true,
              "read-ger": true,
              "update-ger": true,
              "delete-ger": true
            },
            "routing_numbers": {
              "create-routing-numbers": true,
              "read-routing-numbers": true,
              "update-routing-numbers": true,
              "delete-routing-numbers": true
            },
            "global_oncall_reminder_rules": {
              "create-global-oncall-reminder-rules": true,
              "read-global-oncall-reminder-rules": true,
              "update-global-oncall-reminder-rules": true,
              "delete-global-oncall-reminder-rules": true
            }
          }
        }
      ],
      "roles": [
        {
          "id": "text",
          "name": "text",
          "slug": "text",
          "default": true,
          "abilities": {
            "escalation_policies": {
              "create-escalation-policies": true,
              "read-escalation-policies": true,
              "update-escalation-policies": true,
              "delete-escalation-policies": true
            },
            "schedules": {
              "create-schedules": true,
              "read-schedules": true,
              "update-schedules": true,
              "delete-schedules": true
            },
            "services": {
              "create-services": true,
              "read-services": true,
              "update-services": true,
              "delete-services": true
            },
            "squads": {
              "create-squads": true,
              "read-squads": true,
              "update-squads": true,
              "delete-squads": true
            },
            "stakeholder_groups": {
              "create-stakeholder-groups": true,
              "read-stakeholder-groups": true,
              "update-stakeholder-groups": true,
              "delete-stakeholder-groups": true
            },
            "runbooks": {
              "create-runbooks": true,
              "read-runbooks": true,
              "update-runbooks": true,
              "delete-runbooks": true
            },
            "postmortems": {
              "create-postmortems": true,
              "read-postmortems": true,
              "update-postmortems": true,
              "delete-postmortems": true
            },
            "status_pages": {
              "create-status-pages": true,
              "read-status-pages": true,
              "update-status-pages": true,
              "delete-status-pages": true
            },
            "team_analytics": {
              "read-team-analytics": true
            },
            "slos": {
              "create-slos": true,
              "read-slos": true,
              "update-slos": true,
              "delete-slos": true
            },
            "webforms": {
              "create-webforms": true,
              "read-webforms": true,
              "update-webforms": true,
              "delete-webforms": true
            },
            "workflows": {
              "create-workflows": true,
              "read-workflows": true,
              "update-workflows": true,
              "delete-workflows": true
            },
            "ger": {
              "create-ger": true,
              "read-ger": true,
              "update-ger": true,
              "delete-ger": true
            },
            "routing_numbers": {
              "create-routing-numbers": true,
              "read-routing-numbers": true,
              "update-routing-numbers": true,
              "delete-routing-numbers": true
            },
            "global_oncall_reminder_rules": {
              "create-global-oncall-reminder-rules": true,
              "read-global-oncall-reminder-rules": true,
              "update-global-oncall-reminder-rules": true,
              "delete-global-oncall-reminder-rules": true
            }
          }
        }
      ],
      "default": true,
      "organization": {
        "id": "text",
        "name": "text",
        "slug": "text"
      }
    }
  ]
}

Create Team

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams

Add team to the organization. Returns the team object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

descriptionstringOptional

member_idsstring[]Required

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

/v3/teams

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.Create(ctx, components.V3TeamsCreateTeamRequest{
        Name: "<value>",
        MemberIds: []string{
            "<value 1>",
            "<value 2>",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "created_at": "text",
    "updated_at": "text",
    "created_by": "text",
    "organization_id": "text",
    "name": "text",
    "description": "text",
    "slug": "text",
    "members": [
      {
        "user_id": "text",
        "role": "text",
        "role_ids": [
          "text"
        ],
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "roles": [
      {
        "id": "text",
        "name": "text",
        "slug": "text",
        "default": true,
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "default": true,
    "organization": {
      "id": "text",
      "name": "text",
      "slug": "text"
    }
  }
}

Get Team By ID

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}

Returns a team details of the given teamID in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

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

/v3/teams/{teamId}

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.GetByID(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "created_at": "text",
    "updated_at": "text",
    "created_by": "text",
    "organization_id": "text",
    "name": "text",
    "description": "text",
    "slug": "text",
    "members": [
      {
        "user_id": "text",
        "role": "text",
        "role_ids": [
          "text"
        ],
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "roles": [
      {
        "id": "text",
        "name": "text",
        "slug": "text",
        "default": true,
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "default": true,
    "organization": {
      "id": "text",
      "name": "text",
      "slug": "text"
    }
  }
}

Update Team

put

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}

Update organization team details. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

Body

application/json

namestringOptional

descriptionstringOptional

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

/v3/teams/{teamId}

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.Update(ctx, "<id>", components.V3TeamsUpdateTeamRequest{
        Members: []components.V3TeamsUpdateTeamRequestMember{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "created_at": "text",
    "updated_at": "text",
    "created_by": "text",
    "organization_id": "text",
    "name": "text",
    "description": "text",
    "slug": "text",
    "members": [
      {
        "user_id": "text",
        "role": "text",
        "role_ids": [
          "text"
        ],
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "roles": [
      {
        "id": "text",
        "name": "text",
        "slug": "text",
        "default": true,
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "default": true,
    "organization": {
      "id": "text",
      "name": "text",
      "slug": "text"
    }
  }
}

Remove Team

delete

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}

Remove team from the organization. Upon success, the team will be removed from the organization. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

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

/v3/teams/{teamId}

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.Delete(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

Get All Team Members

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/members

Returns all the team members of the organization. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

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

/v3/teams/{teamId}/members

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.Members.GetAll(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "user_id": "text",
      "role": "text",
      "role_ids": [
        "text"
      ],
      "abilities": {
        "escalation_policies": {
          "create-escalation-policies": true,
          "read-escalation-policies": true,
          "update-escalation-policies": true,
          "delete-escalation-policies": true
        },
        "schedules": {
          "create-schedules": true,
          "read-schedules": true,
          "update-schedules": true,
          "delete-schedules": true
        },
        "services": {
          "create-services": true,
          "read-services": true,
          "update-services": true,
          "delete-services": true
        },
        "squads": {
          "create-squads": true,
          "read-squads": true,
          "update-squads": true,
          "delete-squads": true
        },
        "stakeholder_groups": {
          "create-stakeholder-groups": true,
          "read-stakeholder-groups": true,
          "update-stakeholder-groups": true,
          "delete-stakeholder-groups": true
        },
        "runbooks": {
          "create-runbooks": true,
          "read-runbooks": true,
          "update-runbooks": true,
          "delete-runbooks": true
        },
        "postmortems": {
          "create-postmortems": true,
          "read-postmortems": true,
          "update-postmortems": true,
          "delete-postmortems": true
        },
        "status_pages": {
          "create-status-pages": true,
          "read-status-pages": true,
          "update-status-pages": true,
          "delete-status-pages": true
        },
        "team_analytics": {
          "read-team-analytics": true
        },
        "slos": {
          "create-slos": true,
          "read-slos": true,
          "update-slos": true,
          "delete-slos": true
        },
        "webforms": {
          "create-webforms": true,
          "read-webforms": true,
          "update-webforms": true,
          "delete-webforms": true
        },
        "workflows": {
          "create-workflows": true,
          "read-workflows": true,
          "update-workflows": true,
          "delete-workflows": true
        },
        "ger": {
          "create-ger": true,
          "read-ger": true,
          "update-ger": true,
          "delete-ger": true
        },
        "routing_numbers": {
          "create-routing-numbers": true,
          "read-routing-numbers": true,
          "update-routing-numbers": true,
          "delete-routing-numbers": true
        },
        "global_oncall_reminder_rules": {
          "create-global-oncall-reminder-rules": true,
          "read-global-oncall-reminder-rules": true,
          "update-global-oncall-reminder-rules": true,
          "delete-global-oncall-reminder-rules": true
        }
      }
    }
  ]
}

Add Team Member

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/members

Add team member to the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

Body

application/json

user_idstringRequired

role_idsstring[]Required

this field is required if you are using RBAC permission model

rolestringOptional

this field is required if you are using OBAC permission model

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

/v3/teams/{teamId}/members

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.AddMember(ctx, "<id>", components.V3TeamsAddTeamMemberRequest{
        UserID: "<id>",
        RoleIds: []string{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "user_id": "text",
    "role": "text",
    "role_ids": [
      "text"
    ],
    "abilities": {
      "escalation_policies": {
        "create-escalation-policies": true,
        "read-escalation-policies": true,
        "update-escalation-policies": true,
        "delete-escalation-policies": true
      },
      "schedules": {
        "create-schedules": true,
        "read-schedules": true,
        "update-schedules": true,
        "delete-schedules": true
      },
      "services": {
        "create-services": true,
        "read-services": true,
        "update-services": true,
        "delete-services": true
      },
      "squads": {
        "create-squads": true,
        "read-squads": true,
        "update-squads": true,
        "delete-squads": true
      },
      "stakeholder_groups": {
        "create-stakeholder-groups": true,
        "read-stakeholder-groups": true,
        "update-stakeholder-groups": true,
        "delete-stakeholder-groups": true
      },
      "runbooks": {
        "create-runbooks": true,
        "read-runbooks": true,
        "update-runbooks": true,
        "delete-runbooks": true
      },
      "postmortems": {
        "create-postmortems": true,
        "read-postmortems": true,
        "update-postmortems": true,
        "delete-postmortems": true
      },
      "status_pages": {
        "create-status-pages": true,
        "read-status-pages": true,
        "update-status-pages": true,
        "delete-status-pages": true
      },
      "team_analytics": {
        "read-team-analytics": true
      },
      "slos": {
        "create-slos": true,
        "read-slos": true,
        "update-slos": true,
        "delete-slos": true
      },
      "webforms": {
        "create-webforms": true,
        "read-webforms": true,
        "update-webforms": true,
        "delete-webforms": true
      },
      "workflows": {
        "create-workflows": true,
        "read-workflows": true,
        "update-workflows": true,
        "delete-workflows": true
      },
      "ger": {
        "create-ger": true,
        "read-ger": true,
        "update-ger": true,
        "delete-ger": true
      },
      "routing_numbers": {
        "create-routing-numbers": true,
        "read-routing-numbers": true,
        "update-routing-numbers": true,
        "delete-routing-numbers": true
      },
      "global_oncall_reminder_rules": {
        "create-global-oncall-reminder-rules": true,
        "read-global-oncall-reminder-rules": true,
        "update-global-oncall-reminder-rules": true,
        "delete-global-oncall-reminder-rules": true
      }
    }
  }
}

Add Bulk Team Member

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/members/bulk

Add team member to the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

Body

application/json

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

post

/v3/teams/{teamId}/members/bulk

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.AddBulkMember(ctx, "<id>", components.V3TeamsAddBulkTeamMemberRequest{
        Members: []components.V3TeamsAddBulkTeamMemberRequestMember{
            components.V3TeamsAddBulkTeamMemberRequestMember{
                UserID: "<id>",
                RoleIds: []string{
                    "<value 1>",
                    "<value 2>",
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "team_id": "text",
    "members": [
      {
        "user_id": "text",
        "role_ids": [
          "text"
        ]
      }
    ]
  }
}

Remove Team Member

delete

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/members/{memberId}

Remove team member from the team. Upon success, the team member will be removed from the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

memberIdstringRequired

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

/v3/teams/{teamId}/members/{memberId}

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.RemoveMember(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

Update Team Member

patch

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/members/{memberId}

Update team member. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

memberIdstringRequired

Body

application/json

role_idsstring[]Optional

this field is required if you are using RBAC permission model

rolestringOptional

this field is required if you are using OBAC permission model

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

/v3/teams/{teamId}/members/{memberId}

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.UpdateMember(ctx, "<id>", "<id>", components.V3TeamsUpdateTeamMemberRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "user_id": "text",
    "role": "text",
    "role_ids": [
      "text"
    ],
    "abilities": {
      "escalation_policies": {
        "create-escalation-policies": true,
        "read-escalation-policies": true,
        "update-escalation-policies": true,
        "delete-escalation-policies": true
      },
      "schedules": {
        "create-schedules": true,
        "read-schedules": true,
        "update-schedules": true,
        "delete-schedules": true
      },
      "services": {
        "create-services": true,
        "read-services": true,
        "update-services": true,
        "delete-services": true
      },
      "squads": {
        "create-squads": true,
        "read-squads": true,
        "update-squads": true,
        "delete-squads": true
      },
      "stakeholder_groups": {
        "create-stakeholder-groups": true,
        "read-stakeholder-groups": true,
        "update-stakeholder-groups": true,
        "delete-stakeholder-groups": true
      },
      "runbooks": {
        "create-runbooks": true,
        "read-runbooks": true,
        "update-runbooks": true,
        "delete-runbooks": true
      },
      "postmortems": {
        "create-postmortems": true,
        "read-postmortems": true,
        "update-postmortems": true,
        "delete-postmortems": true
      },
      "status_pages": {
        "create-status-pages": true,
        "read-status-pages": true,
        "update-status-pages": true,
        "delete-status-pages": true
      },
      "team_analytics": {
        "read-team-analytics": true
      },
      "slos": {
        "create-slos": true,
        "read-slos": true,
        "update-slos": true,
        "delete-slos": true
      },
      "webforms": {
        "create-webforms": true,
        "read-webforms": true,
        "update-webforms": true,
        "delete-webforms": true
      },
      "workflows": {
        "create-workflows": true,
        "read-workflows": true,
        "update-workflows": true,
        "delete-workflows": true
      },
      "ger": {
        "create-ger": true,
        "read-ger": true,
        "update-ger": true,
        "delete-ger": true
      },
      "routing_numbers": {
        "create-routing-numbers": true,
        "read-routing-numbers": true,
        "update-routing-numbers": true,
        "delete-routing-numbers": true
      },
      "global_oncall_reminder_rules": {
        "create-global-oncall-reminder-rules": true,
        "read-global-oncall-reminder-rules": true,
        "update-global-oncall-reminder-rules": true,
        "delete-global-oncall-reminder-rules": true
      }
    }
  }
}

Get All Team Roles

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/roles

Returns all the roles of the teamId mentioned in params. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

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

/v3/teams/{teamId}/roles

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.GetAllRoles(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "slug": "text",
      "default": true,
      "abilities": {
        "escalation_policies": {
          "create-escalation-policies": true,
          "read-escalation-policies": true,
          "update-escalation-policies": true,
          "delete-escalation-policies": true
        },
        "schedules": {
          "create-schedules": true,
          "read-schedules": true,
          "update-schedules": true,
          "delete-schedules": true
        },
        "services": {
          "create-services": true,
          "read-services": true,
          "update-services": true,
          "delete-services": true
        },
        "squads": {
          "create-squads": true,
          "read-squads": true,
          "update-squads": true,
          "delete-squads": true
        },
        "stakeholder_groups": {
          "create-stakeholder-groups": true,
          "read-stakeholder-groups": true,
          "update-stakeholder-groups": true,
          "delete-stakeholder-groups": true
        },
        "runbooks": {
          "create-runbooks": true,
          "read-runbooks": true,
          "update-runbooks": true,
          "delete-runbooks": true
        },
        "postmortems": {
          "create-postmortems": true,
          "read-postmortems": true,
          "update-postmortems": true,
          "delete-postmortems": true
        },
        "status_pages": {
          "create-status-pages": true,
          "read-status-pages": true,
          "update-status-pages": true,
          "delete-status-pages": true
        },
        "team_analytics": {
          "read-team-analytics": true
        },
        "slos": {
          "create-slos": true,
          "read-slos": true,
          "update-slos": true,
          "delete-slos": true
        },
        "webforms": {
          "create-webforms": true,
          "read-webforms": true,
          "update-webforms": true,
          "delete-webforms": true
        },
        "workflows": {
          "create-workflows": true,
          "read-workflows": true,
          "update-workflows": true,
          "delete-workflows": true
        },
        "ger": {
          "create-ger": true,
          "read-ger": true,
          "update-ger": true,
          "delete-ger": true
        },
        "routing_numbers": {
          "create-routing-numbers": true,
          "read-routing-numbers": true,
          "update-routing-numbers": true,
          "delete-routing-numbers": true
        },
        "global_oncall_reminder_rules": {
          "create-global-oncall-reminder-rules": true,
          "read-global-oncall-reminder-rules": true,
          "update-global-oncall-reminder-rules": true,
          "delete-global-oncall-reminder-rules": true
        }
      }
    }
  ]
}

Create Team Role

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/roles

Add team's role to the team with given ability if not exists. Returns the role object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

Body

application/json

namestringRequired

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

/v3/teams/{teamId}/roles

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.CreateRole(ctx, "<id>", components.V3TeamsCreateTeamRoleRequest{
        Name: "<value>",
        Abilities: components.V3TeamsAbilities{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "created_at": "text",
    "updated_at": "text",
    "created_by": "text",
    "organization_id": "text",
    "name": "text",
    "description": "text",
    "slug": "text",
    "members": [
      {
        "user_id": "text",
        "role": "text",
        "role_ids": [
          "text"
        ],
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "roles": [
      {
        "id": "text",
        "name": "text",
        "slug": "text",
        "default": true,
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "default": true
  }
}

Update Team Role

put

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/roles/{roleId}

Update team's role abilities and name. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

roleIdstringRequired

Body

application/json

namestringOptional

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

/v3/teams/{teamId}/roles/{roleId}

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.UpdateRole(ctx, "<id>", "<id>", components.V3TeamsUpdateTeamRoleRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "created_at": "text",
    "updated_at": "text",
    "created_by": "text",
    "organization_id": "text",
    "name": "text",
    "description": "text",
    "slug": "text",
    "members": [
      {
        "user_id": "text",
        "role": "text",
        "role_ids": [
          "text"
        ],
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "roles": [
      {
        "id": "text",
        "name": "text",
        "slug": "text",
        "default": true,
        "abilities": {
          "escalation_policies": {
            "create-escalation-policies": true,
            "read-escalation-policies": true,
            "update-escalation-policies": true,
            "delete-escalation-policies": true
          },
          "schedules": {
            "create-schedules": true,
            "read-schedules": true,
            "update-schedules": true,
            "delete-schedules": true
          },
          "services": {
            "create-services": true,
            "read-services": true,
            "update-services": true,
            "delete-services": true
          },
          "squads": {
            "create-squads": true,
            "read-squads": true,
            "update-squads": true,
            "delete-squads": true
          },
          "stakeholder_groups": {
            "create-stakeholder-groups": true,
            "read-stakeholder-groups": true,
            "update-stakeholder-groups": true,
            "delete-stakeholder-groups": true
          },
          "runbooks": {
            "create-runbooks": true,
            "read-runbooks": true,
            "update-runbooks": true,
            "delete-runbooks": true
          },
          "postmortems": {
            "create-postmortems": true,
            "read-postmortems": true,
            "update-postmortems": true,
            "delete-postmortems": true
          },
          "status_pages": {
            "create-status-pages": true,
            "read-status-pages": true,
            "update-status-pages": true,
            "delete-status-pages": true
          },
          "team_analytics": {
            "read-team-analytics": true
          },
          "slos": {
            "create-slos": true,
            "read-slos": true,
            "update-slos": true,
            "delete-slos": true
          },
          "webforms": {
            "create-webforms": true,
            "read-webforms": true,
            "update-webforms": true,
            "delete-webforms": true
          },
          "workflows": {
            "create-workflows": true,
            "read-workflows": true,
            "update-workflows": true,
            "delete-workflows": true
          },
          "ger": {
            "create-ger": true,
            "read-ger": true,
            "update-ger": true,
            "delete-ger": true
          },
          "routing_numbers": {
            "create-routing-numbers": true,
            "read-routing-numbers": true,
            "update-routing-numbers": true,
            "delete-routing-numbers": true
          },
          "global_oncall_reminder_rules": {
            "create-global-oncall-reminder-rules": true,
            "read-global-oncall-reminder-rules": true,
            "update-global-oncall-reminder-rules": true,
            "delete-global-oncall-reminder-rules": true
          }
        }
      }
    ],
    "default": true
  }
}

Remove Team Role

delete

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/teams/{teamId}/roles/{roleId}

Remove team's role from the team. Upon success, the team's role will be removed from the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

roleIdstringRequired

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

/v3/teams/{teamId}/roles/{roleId}

Go (SDK)Python (SDK)Typescript (SDK)

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.Teams.RemoveRole(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}