Teams
List the teams inside an organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault:
Limits the number of results to return
10
reversebooleanOptionalDefault:
Order in which to retrieve the results
false
pageTokenstringOptional
Pagination token that keeps of track of the current position in the list
Responses
200
OK
application/json
Responseall of
and
404
Resource not found
application/json
get
GET /organizations/{organizationId}/teams HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"visibility": "public",
"accessibility": "open",
"activeMemberCount": 1,
"pendingMemberCount": 1,
"featuredMembers": [
{
"type": "user",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"createdAt": "2025-07-03T22:55:54.390Z",
"updatedAt": "2025-07-03T22:55:54.390Z"
}
],
"nextPageToken": "text"
}
Create a new team inside the organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
Body
namestring · min: 1 · max: 256Required
descriptionstring · max: 256Required
Responses
201
OK
application/json
404
Resource not found
application/json
422
Request validation failed
application/json
post
POST /organizations/{organizationId}/teams HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 171
{
"name": "text",
"description": "text",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"visibility": "public",
"accessibility": "open",
"activeMemberCount": 1,
"pendingMemberCount": 1,
"featuredMembers": [
{
"type": "user",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"createdAt": "2025-07-03T22:55:54.390Z",
"updatedAt": "2025-07-03T22:55:54.390Z"
}
Retrieve a single team.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
teamIdstringRequired
ID for a team
Responses
200
OK
application/json
404
Resource not found
application/json
get
GET /organizations/{organizationId}/teams/{teamId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"visibility": "public",
"accessibility": "open",
"activeMemberCount": 1,
"pendingMemberCount": 1,
"featuredMembers": [
{
"type": "user",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"createdAt": "2025-07-03T22:55:54.390Z",
"updatedAt": "2025-07-03T22:55:54.390Z"
}
Delete a team from an organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
teamIdstringRequired
ID for a team
Responses
204
OK
404
Resource not found
application/json
delete
DELETE /organizations/{organizationId}/teams/{teamId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Update a team's details.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
teamIdstringRequired
ID for a team
Body
namestring · min: 1 · max: 256Optional
descriptionstring · max: 256Optional
Responses
200
OK
application/json
404
Resource not found
application/json
422
Request validation failed
application/json
patch
PATCH /organizations/{organizationId}/teams/{teamId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 171
{
"name": "text",
"description": "text",
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"visibility": "public",
"accessibility": "open",
"activeMemberCount": 1,
"pendingMemberCount": 1,
"featuredMembers": [
{
"type": "user",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"roleRefs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "organization",
"workspaces": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"createdAt": "2025-07-03T22:55:54.390Z",
"updatedAt": "2025-07-03T22:55:54.390Z"
}
Last updated
Was this helpful?