Teams | Bird API Docs

No-code docs

Get team

get

Retrieve a single team.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

teamIdstringRequired

ID for a team

Responses

application/json

objectOptional

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-04-18T23:56:11.593Z",
  "updatedAt": "2025-04-18T23:56:11.593Z"
}

Delete team

delete

Delete a team from an organization.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

teamIdstringRequired

ID for a team

Responses

application/json

delete

DELETE /organizations/{organizationId}/teams/{teamId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

List teams

get

List the teams inside an organization.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

reversebooleanOptional

Order in which to retrieve the results

Default: false

pageTokenstringOptional

Pagination token that keeps of track of the current position in the list

Responses

application/json

all ofOptional

A list of results that supports pagination.

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-04-18T23:56:11.593Z",
      "updatedAt": "2025-04-18T23:56:11.593Z"
    }
  ],
  "nextPageToken": "text"
}

Create team

post

Create a new team inside the organization.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Body

namestring · min: 1 · max: 256Required

descriptionstring · max: 256Required

roleRefsobject[] | nullableOptional

The list of roles assigned to the team

Responses

application/json

objectOptional

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-04-18T23:56:11.593Z",
  "updatedAt": "2025-04-18T23:56:11.593Z"
}

Update team

patch

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

roleRefsobject[] | nullableOptional

The list of roles assigned to the team

Responses

application/json

objectOptional

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-04-18T23:56:11.593Z",
  "updatedAt": "2025-04-18T23:56:11.593Z"
}