DocumentazioneEngagement Platform API
Sign inGet started
Guides
API

Teams

GET
/organizations/{organizationId}/teams
List the teams inside an organization.
Parametri di query
limit
integer
Limits the number of results to return.
reverse
boolean
Reverses the order in which the results are returned.
pageToken
string
The cursor that keeps track of the current position in the results.
Payload della risposta
results
array of object
obbligatorio
Mostra attributi secondari
results.id
string
obbligatorio
results.name
string
obbligatorio
results.description
string
obbligatorio
results.visibility
string
obbligatorio
Possible values: public, private
results.accessibility
string
obbligatorio
Possible values: open, request-to-join, invite-only
results.activeMemberCount
integer
obbligatorio
results.pendingMemberCount
integer
obbligatorio
results.featuredMembers
array of object
obbligatorio
Mostra attributi secondari
results.featuredMembers.type
string
obbligatorio
Possible values: user
results.featuredMembers.id
string
obbligatorio
results.roleRefs
array of object
The list of roles assigned to the team
Mostra attributi secondari
results.roleRefs.id
string
obbligatorio
results.roleRefs.type
string
obbligatorio
Possible values: organization, managed
results.roleRefs.workspaces
array of string
results.createdAt
string
obbligatorio
results.updatedAt
string
obbligatorio
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
Esempio di codice
curl -X GET 'https://api.bird.com/organizations/{organizationId}/teams' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/organizations/{organizationId}/teams
Create a new team inside the organization.
Payload della richiesta
name
string
obbligatorio
description
string
obbligatorio
roleRefs
array of object
The list of roles assigned to the team
Mostra parametri secondari
roleRefs.id
string
obbligatorio
roleRefs.type
string
obbligatorio
Possible values: organization, managed
roleRefs.workspaces
array of string
Payload della risposta
id
string
obbligatorio
name
string
obbligatorio
description
string
obbligatorio
visibility
string
obbligatorio
Possible values: public, private
accessibility
string
obbligatorio
Possible values: open, request-to-join, invite-only
activeMemberCount
integer
obbligatorio
pendingMemberCount
integer
obbligatorio
featuredMembers
array of object
obbligatorio
Mostra attributi secondari
featuredMembers.type
string
obbligatorio
Possible values: user
featuredMembers.id
string
obbligatorio
roleRefs
array of object
The list of roles assigned to the team
Mostra attributi secondari
roleRefs.id
string
obbligatorio
roleRefs.type
string
obbligatorio
Possible values: organization, managed
roleRefs.workspaces
array of string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X POST 'https://api.bird.com/organizations/{organizationId}/teams' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/organizations/{organizationId}/teams/{teamId}
Retrieve a single team.
Payload della risposta
id
string
obbligatorio
name
string
obbligatorio
description
string
obbligatorio
visibility
string
obbligatorio
Possible values: public, private
accessibility
string
obbligatorio
Possible values: open, request-to-join, invite-only
activeMemberCount
integer
obbligatorio
pendingMemberCount
integer
obbligatorio
featuredMembers
array of object
obbligatorio
Mostra attributi secondari
featuredMembers.type
string
obbligatorio
Possible values: user
featuredMembers.id
string
obbligatorio
roleRefs
array of object
The list of roles assigned to the team
Mostra attributi secondari
roleRefs.id
string
obbligatorio
roleRefs.type
string
obbligatorio
Possible values: organization, managed
roleRefs.workspaces
array of string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/organizations/{organizationId}/teams/{teamId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/organizations/{organizationId}/teams/{teamId}
Delete a team from an organization.
Esempio di codice
curl -X DELETE 'https://api.bird.com/organizations/{organizationId}/teams/{teamId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/organizations/{organizationId}/teams/{teamId}
Update a team's details.
Payload della richiesta
name
string
description
string
roleRefs
array of object
The list of roles assigned to the team
Mostra parametri secondari
roleRefs.id
string
obbligatorio
roleRefs.type
string
obbligatorio
Possible values: organization, managed
roleRefs.workspaces
array of string
Payload della risposta
id
string
obbligatorio
name
string
obbligatorio
description
string
obbligatorio
visibility
string
obbligatorio
Possible values: public, private
accessibility
string
obbligatorio
Possible values: open, request-to-join, invite-only
activeMemberCount
integer
obbligatorio
pendingMemberCount
integer
obbligatorio
featuredMembers
array of object
obbligatorio
Mostra attributi secondari
featuredMembers.type
string
obbligatorio
Possible values: user
featuredMembers.id
string
obbligatorio
roleRefs
array of object
The list of roles assigned to the team
Mostra attributi secondari
roleRefs.id
string
obbligatorio
roleRefs.type
string
obbligatorio
Possible values: organization, managed
roleRefs.workspaces
array of string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/teams/{teamId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'