DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Users

GET
/organizations/{organizationId}/users
Get a list of members for an organization.
Queryparameters
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
preview
boolean
searchTerm
string
Search term used to filter organizations by name
userIds
array
List of user IDs.
email
string
Get an organization membership for this email address. Exact matching only.
status
string
Filter organization memberships by their status.
Possible values: banned, invited, active
role
array
Filter organization memberships by their role.
Antwoord-payload
results
array of object
verplicht
Onderliggende attributen tonen
results.user
object
verplicht
Onderliggende attributen tonen
A user on the platform.
results.user.activeSessions
integer
verplicht
The number of logged in session for the user.
results.user.avatarUrl
string
URL to the user's profile picture.
results.user.badges
array of string
results.user.bio
string
The user's description
results.user.createdAt
string
verplicht
When the user was created.
results.user.defaultEmail
string
The default email of the user in the list of emails.
results.user.emails
array of object
verplicht
Email addresses associated with user.
Onderliggende attributen tonen
results.user.emails.createdAt
string
verplicht
When this record was created.
results.user.emails.email
string
verplicht
The email address.
results.user.emails.id
string
verplicht
ID of the email record.
results.user.emails.passwordSet
boolean
verplicht
Whether there is a password set for this email address.
results.user.emails.tokenSet
boolean
verplicht
Whether there is a token set for this email address.
results.user.emails.updatedAt
string
When this record was last updated.
results.user.emails.userId
string
verplicht
ID of the user this record is associated with.
results.user.emails.verified
boolean
verplicht
Whether the email address is verified.
results.user.id
string
verplicht
ID of the user
results.user.identities
array of object
Third-party identities associated with user.
Onderliggende attributen tonen
results.user.identities.avatarUrl
string
The avatar URL of the user on the third-party provider.
results.user.identities.createdAt
string
Timestamp when the identity was created.
results.user.identities.email
string
The email of the user on the third-party provider.
results.user.identities.id
string
The ID of the user on the third-party provider.
results.user.identities.name
string
The name of the user on the third-party provider.
results.user.identities.provider
string
The name of the provider
results.user.identities.updatedAt
string
Timestamp when the identity was last updated.
results.user.locale
string
results.user.name
string
verplicht
The display name for the user
results.user.phoneNumber
string
results.user.phoneNumbers
array of object
verplicht
The phone numbers associated with the user.
Onderliggende attributen tonen
results.user.phoneNumbers.createdAt
string
verplicht
results.user.phoneNumbers.id
string
verplicht
results.user.phoneNumbers.phoneNumber
string
verplicht
results.user.phoneNumbers.primary
boolean
verplicht
results.user.phoneNumbers.updatedAt
string
verplicht
results.user.phoneNumbers.userId
string
verplicht
results.user.phoneNumbers.verified
boolean
verplicht
results.user.status
string
verplicht
The status of the user
Possible values: pending, active, deleted, invited, banned
results.user.timezone
string
The default timezone for the user.
results.user.updatedAt
string
verplicht
When the user was last updated.
results.user.userFraudInformation
object
Onderliggende attributen tonen
results.user.userFraudInformation.score
number
Fraud score
results.user.userFraudInformation.userId
string
Fraud user id
results.status
string
verplicht
The status of user's membership on the organization.
Possible values: banned, invited, active
results.createdAt
string
verplicht
When the membership was created.
results.updatedAt
string
verplicht
When the membership was last updated.
results.attributes
object
Authorization context for the membership.
results.roleIds
array of string
IDs of IAM roles assigned to the user.
results.roleRefs
array of object
The list of roles to assign to the membership
Onderliggende attributen tonen
results.roleRefs.id
string
verplicht
results.roleRefs.type
string
verplicht
Possible values: organization, managed
results.roleRefs.workspaces
array of string
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
Codevoorbeeld
curl -X GET 'https://api.bird.com/organizations/{organizationId}/users' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/organizations/{organizationId}/users
Add a user to an organization. This can either be an existing user, or a new user that is invited to the platform.
Verzoek-payload
Add an existing user to the organization
userId
string
verplicht
The user ID
roleRefs
array of object
The list of roles to assign to the membership
Onderliggende parameters tonen
roleRefs.id
string
verplicht
roleRefs.type
string
verplicht
Possible values: organization, managed
roleRefs.workspaces
array of string
roleIds
array of string
The list of Role IDs to assign to the user
attributes
object
Structured attributes for organization user membership (preferred method)
Onderliggende parameters tonen
attributes.roles
array of string
List of role slugs (consistent with workspace users)
Codevoorbeeld
curl -X POST 'https://api.bird.com/organizations/{organizationId}/users' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/organizations/{organizationId}/users/{userId}
Get a single organization membership record.
Queryparameters
preview
boolean
Antwoord-payload
user
object
verplicht
Onderliggende attributen tonen
A user on the platform.
user.activeSessions
integer
verplicht
The number of logged in session for the user.
user.avatarUrl
string
URL to the user's profile picture.
user.badges
array of string
user.bio
string
The user's description
user.createdAt
string
verplicht
When the user was created.
user.defaultEmail
string
The default email of the user in the list of emails.
user.emails
array of object
verplicht
Email addresses associated with user.
Onderliggende attributen tonen
user.emails.createdAt
string
verplicht
When this record was created.
user.emails.email
string
verplicht
The email address.
user.emails.id
string
verplicht
ID of the email record.
user.emails.passwordSet
boolean
verplicht
Whether there is a password set for this email address.
user.emails.tokenSet
boolean
verplicht
Whether there is a token set for this email address.
user.emails.updatedAt
string
When this record was last updated.
user.emails.userId
string
verplicht
ID of the user this record is associated with.
user.emails.verified
boolean
verplicht
Whether the email address is verified.
user.id
string
verplicht
ID of the user
user.identities
array of object
Third-party identities associated with user.
Onderliggende attributen tonen
user.identities.avatarUrl
string
The avatar URL of the user on the third-party provider.
user.identities.createdAt
string
Timestamp when the identity was created.
user.identities.email
string
The email of the user on the third-party provider.
user.identities.id
string
The ID of the user on the third-party provider.
user.identities.name
string
The name of the user on the third-party provider.
user.identities.provider
string
The name of the provider
user.identities.updatedAt
string
Timestamp when the identity was last updated.
user.locale
string
user.name
string
verplicht
The display name for the user
user.phoneNumber
string
user.phoneNumbers
array of object
verplicht
The phone numbers associated with the user.
Onderliggende attributen tonen
user.phoneNumbers.createdAt
string
verplicht
user.phoneNumbers.id
string
verplicht
user.phoneNumbers.phoneNumber
string
verplicht
user.phoneNumbers.primary
boolean
verplicht
user.phoneNumbers.updatedAt
string
verplicht
user.phoneNumbers.userId
string
verplicht
user.phoneNumbers.verified
boolean
verplicht
user.status
string
verplicht
The status of the user
Possible values: pending, active, deleted, invited, banned
user.timezone
string
The default timezone for the user.
user.updatedAt
string
verplicht
When the user was last updated.
user.userFraudInformation
object
Onderliggende attributen tonen
user.userFraudInformation.score
number
Fraud score
user.userFraudInformation.userId
string
Fraud user id
status
string
verplicht
The status of user's membership on the organization.
Possible values: banned, invited, active
createdAt
string
verplicht
When the membership was created.
updatedAt
string
verplicht
When the membership was last updated.
roleIds
array of string
IDs of IAM roles assigned to the user.
roleRefs
array of object
The list of roles to assign to the membership
Onderliggende attributen tonen
roleRefs.id
string
verplicht
roleRefs.type
string
verplicht
Possible values: organization, managed
roleRefs.workspaces
array of string
teamRoles
array of object
The list of roles inherited from teams
Onderliggende attributen tonen
teamRoles.id
string
verplicht
teamRoles.name
string
verplicht
teamRoles.roleRefs
array of object
The list of roles assigned to the team
Onderliggende attributen tonen
teamRoles.roleRefs.id
string
verplicht
teamRoles.roleRefs.type
string
verplicht
Possible values: organization, managed
teamRoles.roleRefs.workspaces
array of string
attributes
object
Additional attributes for the membership
Codevoorbeeld
curl -X GET 'https://api.bird.com/organizations/{organizationId}/users/{userId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/organizations/{organizationId}/users/{userId}
Remove a user from the organization
Codevoorbeeld
curl -X DELETE 'https://api.bird.com/organizations/{organizationId}/users/{userId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/organizations/{organizationId}/users/{userId}
Update the properties of the organization membership for the user.
Verzoek-payload
roleRefs
array of object
The list of roles to assign to the membership (legacy, use attributes instead)
Onderliggende parameters tonen
roleRefs.id
string
verplicht
roleRefs.type
string
verplicht
Possible values: organization, managed
roleRefs.workspaces
array of string
roleIds
array of string
Roles to assign to the user (legacy, use attributes instead)
attributes
object
Structured attributes for organization user membership (preferred method)
Onderliggende parameters tonen
attributes.roles
array of string
List of role slugs (consistent with workspace users)
roleTreatment
string
Used to allow removing the legacy roles for the user
Antwoord-payload
user
object
verplicht
Onderliggende attributen tonen
A user on the platform.
user.activeSessions
integer
verplicht
The number of logged in session for the user.
user.avatarUrl
string
URL to the user's profile picture.
user.badges
array of string
user.bio
string
The user's description
user.createdAt
string
verplicht
When the user was created.
user.defaultEmail
string
The default email of the user in the list of emails.
user.emails
array of object
verplicht
Email addresses associated with user.
Onderliggende attributen tonen
user.emails.createdAt
string
verplicht
When this record was created.
user.emails.email
string
verplicht
The email address.
user.emails.id
string
verplicht
ID of the email record.
user.emails.passwordSet
boolean
verplicht
Whether there is a password set for this email address.
user.emails.tokenSet
boolean
verplicht
Whether there is a token set for this email address.
user.emails.updatedAt
string
When this record was last updated.
user.emails.userId
string
verplicht
ID of the user this record is associated with.
user.emails.verified
boolean
verplicht
Whether the email address is verified.
user.id
string
verplicht
ID of the user
user.identities
array of object
Third-party identities associated with user.
Onderliggende attributen tonen
user.identities.avatarUrl
string
The avatar URL of the user on the third-party provider.
user.identities.createdAt
string
Timestamp when the identity was created.
user.identities.email
string
The email of the user on the third-party provider.
user.identities.id
string
The ID of the user on the third-party provider.
user.identities.name
string
The name of the user on the third-party provider.
user.identities.provider
string
The name of the provider
user.identities.updatedAt
string
Timestamp when the identity was last updated.
user.locale
string
user.name
string
verplicht
The display name for the user
user.phoneNumber
string
user.phoneNumbers
array of object
verplicht
The phone numbers associated with the user.
Onderliggende attributen tonen
user.phoneNumbers.createdAt
string
verplicht
user.phoneNumbers.id
string
verplicht
user.phoneNumbers.phoneNumber
string
verplicht
user.phoneNumbers.primary
boolean
verplicht
user.phoneNumbers.updatedAt
string
verplicht
user.phoneNumbers.userId
string
verplicht
user.phoneNumbers.verified
boolean
verplicht
user.status
string
verplicht
The status of the user
Possible values: pending, active, deleted, invited, banned
user.timezone
string
The default timezone for the user.
user.updatedAt
string
verplicht
When the user was last updated.
user.userFraudInformation
object
Onderliggende attributen tonen
user.userFraudInformation.score
number
Fraud score
user.userFraudInformation.userId
string
Fraud user id
status
string
verplicht
The status of user's membership on the organization.
Possible values: banned, invited, active
createdAt
string
verplicht
When the membership was created.
updatedAt
string
verplicht
When the membership was last updated.
attributes
object
Authorization context for the membership.
roleIds
array of string
IDs of IAM roles assigned to the user.
roleRefs
array of object
The list of roles to assign to the membership
Onderliggende attributen tonen
roleRefs.id
string
verplicht
roleRefs.type
string
verplicht
Possible values: organization, managed
roleRefs.workspaces
array of string
Codevoorbeeld
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/users/{userId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'