Teams

Overview

Available Operations

• GetAll - Get All Teams
• Create - Create Team
• GetByID - Get Team By ID
• Update - Update Team
• Delete - Remove Team
• AddMember - Add Team Member
• AddBulkMember - Add Bulk Team Member
• RemoveMember - Remove Team Member
• UpdateMember - Update Team Member
• GetAllRoles - Get All Team Roles
• CreateRole - Create Team Role
• RemoveRole - Remove Team Role
• UpdateRole - Update Team Role

GetAll

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

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsGetAllTeamsResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

Create

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.

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	components.V3TeamsCreateTeamRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsCreateTeamResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

GetByID

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.

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsGetTeamByIDResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

Update

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

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
v3TeamsUpdateTeamRequest	components.V3TeamsUpdateTeamRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsUpdateTeamResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

Delete

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.

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsRemoveTeamResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

AddMember

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

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
v3TeamsAddTeamMemberRequest	components.V3TeamsAddTeamMemberRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsAddTeamMemberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

AddBulkMember

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

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
v3TeamsAddBulkTeamMemberRequest	components.V3TeamsAddBulkTeamMemberRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsAddBulkTeamMemberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

RemoveMember

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.

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
memberID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsRemoveTeamMemberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

UpdateMember

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

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
memberID	string	✔️	N/A
v3TeamsUpdateTeamMemberRequest	components.V3TeamsUpdateTeamMemberRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsUpdateTeamMemberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

GetAllRoles

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

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsGetAllTeamRolesResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

CreateRole

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.

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
v3TeamsCreateTeamRoleRequest	components.V3TeamsCreateTeamRoleRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsCreateTeamRoleResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

RemoveRole

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.

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
teamID	string	✔️	N/A
roleID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.TeamsRemoveTeamRoleResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

UpdateRole

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

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.