Docs Open org

API reference

Teams API

Nested teams

GET /orgs/{org}/teams

Every team.

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.

Responses

200
OK. Paged_Team application/json

POST /orgs/{org}/teams

Creates a team (admins, or managers of the parent team).

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.

Request body

application/json, CreateTeam.

FieldTypeDescription
handle requiredstringHandle.
name requiredstringName.
parentstring | nullThe parent team's handle.

Responses

201
Created. Team application/json

GET /orgs/{org}/teams/{handle}

A team and its members.

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.
handle requiredpathstringThe team's handle.

Responses

200
OK. Team application/json

PATCH /orgs/{org}/teams/{handle}

Renames or moves a team (its managers; moving needs the new parent too).

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.
handle requiredpathstringThe team's handle.

Request body

application/json, UpdateTeam.

FieldTypeDescription
namestring | nullName.
parentstring | nullNew parent handle; "" makes it top-level.

Responses

200
OK. Team application/json

DELETE /orgs/{org}/teams/{handle}

Deletes a team (its grants go with it; child teams become top-level).

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.
handle requiredpathstringThe team's handle.

Responses

204
No content

PUT /orgs/{org}/teams/{handle}/members/{member}

Adds a member to a team, or changes whether they manage it.

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.
handle requiredpathstringThe team's handle.
member requiredpathstringThe member's handle.

Request body

application/json, PutMember.

FieldTypeDescription
is_managerbooleanWhether the member manages the team.

Responses

200
OK. Team application/json

DELETE /orgs/{org}/teams/{handle}/members/{member}

Removes a member from a team.

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.
handle requiredpathstringThe team's handle.
member requiredpathstringThe member's handle.

Responses

204
No content