Team Management | Bird API Docs

No-code docs

List teams

get

Retrieve a list of teams within the workspace, showcasing their members count and other details.

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10optional

Limits the number of results to return

pageTokenstring · max: 8000optional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

sortBystring · enumoptional

Sort by field specified

Options: name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/teams' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "visibility": "text",
      "accessibility": "text",
      "activeMemberCount": 1,
      "pendingMemberCount": 1,
      "featuredMembers": [
        {
          "id": "text",
          "type": "text"
        }
      ],
      "hideFromViews": true,
      "createdAt": "2025-03-28T18:41:30.067Z",
      "updatedAt": "2025-03-28T18:41:30.067Z"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Get team

get

Retrieve information about a specific team within the workspace, including its name, and other details.

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/teams/{teamId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": true,
  "createdAt": "2025-03-28T18:41:30.067Z",
  "updatedAt": "2025-03-28T18:41:30.067Z"
}

Delete team

delete

Remove a specific team from the workspace, permanently deleting its profile and associated data.

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/teams/{teamId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

Deleted

List members

get

Retrieve a list of members within the team, showcasing their names and other details.

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/teams/{teamId}/members' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "text",
      "teamId": "text",
      "type": "text",
      "status": "text",
      "createdAt": "2025-03-28T18:41:30.067Z",
      "updatedAt": "2025-03-28T18:41:30.067Z"
    }
  ]
}

Get member

get

Retrieve information about a specific member within the team, including their name and other details.

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

teamMemberUserIDstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "text",
  "teamId": "text",
  "type": "text",
  "status": "text",
  "createdAt": "2025-03-28T18:41:30.067Z",
  "updatedAt": "2025-03-28T18:41:30.067Z"
}

Remove member

delete

Remove a specific member from the team.

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

teamMemberUserIDstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

deleted

Create team

post

Create a new team within the workspace, defining its name, and other relevant attributes.

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 5 · max: 20required

descriptionstring · max: 240optional

hideFromViewsboolean · default: falseoptional

membersobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/teams' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "hideFromViews": true,
    "members": [
      {
        "id": "text",
        "type": "text"
      }
    ]
  }'

201

404

422

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": true,
  "createdAt": "2025-03-28T18:41:30.067Z",
  "updatedAt": "2025-03-28T18:41:30.067Z"
}

Created

Update team

patch

Modify the details of a specific team within the workspace, such as its name, or other attributes.

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Body

namestring · min: 5 · max: 20optional

descriptionstring · max: 240optional

hideFromViewsbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/teams/{teamId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "hideFromViews": true
  }'

200

404

422

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": true,
  "createdAt": "2025-03-28T18:41:30.067Z",
  "updatedAt": "2025-03-28T18:41:30.067Z"
}

Create member

post

Add a new member to the team.

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Body

idstring · min: 1required

typestring · enum · min: 1required

Options: user

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/teams/{teamId}/members' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "type": "user"
  }'

201

404

409

422

{
  "id": "text",
  "teamId": "text",
  "type": "text",
  "status": "text",
  "createdAt": "2025-03-28T18:41:30.067Z",
  "updatedAt": "2025-03-28T18:41:30.067Z"
}

Created

List teams

Get team

Delete team

List members

Get member

Remove member

Create team

Show child attributes

Update team

Create member