Squads

Overview

Available Operations

• list - Get All Squads
• get_by_id - Get Squad By ID
• update_v4 - Update Squad
• remove_member - Remove Squad Member
• delete - Delete Squad

list

This endpoint is used to get all the squads details of your organization. Requires access_token as a Bearer {{token}} in the Authorization header with squad-read scope.

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.squads.list(owner_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
owner_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SquadsGetAllSquadsResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

get_by_id

This endpoint is used to get the squads details by id. Requires access_token as a Bearer {{token}} in the Authorization header with squad-read scope.

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.squads.get_by_id(squad_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
squad_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SquadsGetSquadByIDResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update_v4

This endpoint is used to update squad.

The role will be considered only if your organization is on the OBAC permission model; otherwise, the role field will be ignored, and only the member will be added to the squad. Requires access_token as a Bearer {{token}} in the Authorization header with squad-create scope.

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.squads.update_v4(squad_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
squad_id	str	✔️	N/A
name	Optional[str]	➖	N/A
members	List[models.V4SquadsSquadMember]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SquadsUpdateSquadResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

remove_member

This endpoint is used to update squad member's role.

If you're attempting to remove a member whose role is 'owner', and that 'owner' is the last squad owner, then the 'replaceWith' query parameter is required. Setting 'replaceWith' to 'member' will promote another member as the owner, and the specified member will be removed.

Requires access_token as a Bearer {{token}} in the Authorization header with squad-create scope.

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.squads.remove_member(squad_id="<id>", member_id="<id>", replace_with="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
squad_id	str	✔️	N/A
member_id	str	✔️	N/A
replace_with	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.V4SquadsRemoveSquadMemberResponse

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

delete

This endpoint is used to delete the squad. Squad should not be assigned to any incident or part of any escalation policy. Requires access_token as a Bearer {{token}} in the Authorization header with squad-update scope.

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.squads.delete(squad_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
squad_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type	Status Code	Content Type
errors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
errors.CommonV4Error	500, 502, 503, 504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*