Skip to main content
These endpoints let you list, invite, remove, and manage the roles of members in your organization. You can also revoke pending invitations.
All team management endpoints require the org:admin role. Requests from non-admin members will receive a 401 not_authorized error.

GET /api/team/members

List all current members of your organization and any pending invitations. Authentication
Example request
Example response
Error codes

POST /api/team/members/invite

Send an invitation to a new member by email address. The invited person will receive an email prompting them to join your organization. Authentication
Request body
emailAddress
string
required
The email address to send the invitation to. Must be a valid email and no longer than 320 characters.
role
"org:admin" | "org:member"
required
The role to assign to the invitee upon accepting. Use org:admin to grant admin access or org:member for standard access.
Example request
Example response
Error codes

PATCH /api/team/members//role

Update the role of an existing organization member.
You cannot change your own role. Attempting to do so returns a 400 cannot_change_own_role error. Similarly, you cannot remove yourself from the organization — that returns a 400 cannot_remove_self error on the delete endpoint.
Authentication
Path parameters
userId
string
required
The ID of the member whose role you want to update. You can retrieve member IDs from the GET /api/team/members response.
Request body
role
"org:admin" | "org:member"
required
The new role to assign to the member.
Example request
Example response
Error codes

DELETE /api/team/members/

Remove a member from your organization. This revokes their access immediately. Authentication
Path parameters
userId
string
required
The ID of the member to remove. You can retrieve member IDs from the GET /api/team/members response.
Example request
Example response
Error codes

DELETE /api/team/members/invitations/

Revoke a pending invitation. The invitee will no longer be able to accept it. Authentication
Path parameters
invitationId
string
required
The ID of the invitation to revoke. You can retrieve invitation IDs from the GET /api/team/members response.
Example request
Example response
Error codes