DokumentasiEngagement Platform API
Sign inGet started
Guides
API

Teams

GET
/organizations/{organizationId}/teams
List the teams inside an organization.
Parameter 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 respons
results
array of object
wajib
Tampilkan atribut turunan
results.id
string
wajib
results.name
string
wajib
results.description
string
wajib
results.visibility
string
wajib
Possible values: public, private
results.accessibility
string
wajib
Possible values: open, request-to-join, invite-only
results.activeMemberCount
integer
wajib
results.pendingMemberCount
integer
wajib
results.featuredMembers
array of object
wajib
Tampilkan atribut turunan
results.featuredMembers.type
string
wajib
Possible values: user
results.featuredMembers.id
string
wajib
results.roleRefs
array of object
The list of roles assigned to the team
Tampilkan atribut turunan
results.roleRefs.id
string
wajib
results.roleRefs.type
string
wajib
Possible values: organization, managed
results.roleRefs.workspaces
array of string
results.createdAt
string
wajib
results.updatedAt
string
wajib
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
Contoh kode
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 permintaan
name
string
wajib
description
string
wajib
roleRefs
array of object
The list of roles assigned to the team
Tampilkan parameter turunan
roleRefs.id
string
wajib
roleRefs.type
string
wajib
Possible values: organization, managed
roleRefs.workspaces
array of string
Payload respons
id
string
wajib
name
string
wajib
description
string
wajib
visibility
string
wajib
Possible values: public, private
accessibility
string
wajib
Possible values: open, request-to-join, invite-only
activeMemberCount
integer
wajib
pendingMemberCount
integer
wajib
featuredMembers
array of object
wajib
Tampilkan atribut turunan
featuredMembers.type
string
wajib
Possible values: user
featuredMembers.id
string
wajib
roleRefs
array of object
The list of roles assigned to the team
Tampilkan atribut turunan
roleRefs.id
string
wajib
roleRefs.type
string
wajib
Possible values: organization, managed
roleRefs.workspaces
array of string
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
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 respons
id
string
wajib
name
string
wajib
description
string
wajib
visibility
string
wajib
Possible values: public, private
accessibility
string
wajib
Possible values: open, request-to-join, invite-only
activeMemberCount
integer
wajib
pendingMemberCount
integer
wajib
featuredMembers
array of object
wajib
Tampilkan atribut turunan
featuredMembers.type
string
wajib
Possible values: user
featuredMembers.id
string
wajib
roleRefs
array of object
The list of roles assigned to the team
Tampilkan atribut turunan
roleRefs.id
string
wajib
roleRefs.type
string
wajib
Possible values: organization, managed
roleRefs.workspaces
array of string
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
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.
Contoh kode
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 permintaan
name
string
description
string
roleRefs
array of object
The list of roles assigned to the team
Tampilkan parameter turunan
roleRefs.id
string
wajib
roleRefs.type
string
wajib
Possible values: organization, managed
roleRefs.workspaces
array of string
Payload respons
id
string
wajib
name
string
wajib
description
string
wajib
visibility
string
wajib
Possible values: public, private
accessibility
string
wajib
Possible values: open, request-to-join, invite-only
activeMemberCount
integer
wajib
pendingMemberCount
integer
wajib
featuredMembers
array of object
wajib
Tampilkan atribut turunan
featuredMembers.type
string
wajib
Possible values: user
featuredMembers.id
string
wajib
roleRefs
array of object
The list of roles assigned to the team
Tampilkan atribut turunan
roleRefs.id
string
wajib
roleRefs.type
string
wajib
Possible values: organization, managed
roleRefs.workspaces
array of string
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/teams/{teamId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'