REST API endpoints for Organization Members
List the members of an organization
Section titled “List the members of an organization”/orgs/{orgId}/members List joined members in the organization.
Authentication may enable this endpoint return more information.
The organization owner receives private membership fields, including accepted.
orgIdstringRequiredThe slug or ID of the organization.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
The array of members.
idstringRequiredThe unique identifier of the user.
namestringRequiredThe display name of the user.
usernamestringRequiredThe username of the user.
created_atstringRequiredISO 8601 timestamp of when the user was created.
rolestringRequiredThe role of the user. Can be user, moderator or admin.
avatar_urlstringThe URL of the user avatar.
biostringThe short bio of the user.
is_ownerbooleanRequiredWhether the user is the owner of the organization.
member_rolestringRequiredThe role of the member in the organization.
permissionsarray<string>RequiredThe permissions that the member has in the organization.
Get an organization member
Section titled “Get an organization member”/orgs/{orgId}/members/{userId} Authentication may enable this endpoint return more information.
The organization owner or the requested member receives private membership fields, including accepted.
orgIdstringRequiredThe slug or ID of the organization.
userIdstringRequiredThe ID or username of the member.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
idstringRequiredThe unique identifier of the user.
namestringRequiredThe display name of the user.
usernamestringRequiredThe username of the user.
created_atstringRequiredISO 8601 timestamp of when the user was created.
rolestringRequiredThe role of the user. Can be user, moderator or admin.
avatar_urlstringThe URL of the user avatar.
biostringThe short bio of the user.
is_ownerbooleanRequiredWhether the user is the owner of the organization.
member_rolestringRequiredThe role of the member in the organization.
permissionsarray<string>RequiredThe permissions that the member has in the organization.
Update an organization member
Section titled “Update an organization member”/orgs/{orgId}/members/{userId} Authentication is required.
The authenticated member must have member:update permission in the organization.
orgIdstringRequiredThe slug or ID of the organization.
userIdstringRequiredThe ID or username of the member.
Permissions use organization member permission values: member:create, member:update, member:delete, project:create, project:read, project:update, project:delete, project:channel:create, project:channel:update, project:channel:delete, project:version:create, project:version:update, project:version:delete.
rolestringThe member role. Minimum 1 and maximum 32 characters.
permissionsarray<string>Organization member permissions.
Remove an organization member
Section titled “Remove an organization member”/orgs/{orgId}/members/{userId} Authentication is required.
A member can remove themselves. Removing another member requires member:delete permission. The owner cannot be removed.
orgIdstringRequiredThe slug or ID of the organization.
userIdstringRequiredThe ID or username of the member.