Skip to content

Members

List Members

List all members of the organization.

Requires membership in the organization.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseMemberListResponse
422Validation ErrorHTTPValidationError

GET /api/orgs/{org_id}/members/{member_id}

Section titled “GET /api/orgs/{org_id}/members/{member_id}”

Get Member

Get details of a specific member.

Requires membership in the organization.

Parameters

NameInTypeRequiredDescription
member_idpathstring (uuid)yes
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseMemberResponse
422Validation ErrorHTTPValidationError

PATCH /api/orgs/{org_id}/members/{member_id}

Section titled “PATCH /api/orgs/{org_id}/members/{member_id}”

Update Member

Update a member’s role.

Requires ADMIN or OWNER role. Only OWNER can promote to ADMIN or OWNER. Cannot change your own role. Cannot demote the last OWNER.

Parameters

NameInTypeRequiredDescription
member_idpathstring (uuid)yes
org_idpathstring (uuid)yes

Request body (required)

FieldTypeRequiredDescription
rolestringyes

Responses

StatusDescriptionBody
200Successful ResponseMemberResponse
422Validation ErrorHTTPValidationError

DELETE /api/orgs/{org_id}/members/{member_id}

Section titled “DELETE /api/orgs/{org_id}/members/{member_id}”

Remove Member

Remove a member from the organization.

Requires ADMIN or OWNER role. Cannot remove yourself (use a leave endpoint instead). Cannot remove the last OWNER.

Parameters

NameInTypeRequiredDescription
member_idpathstring (uuid)yes
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
204Successful Response
422Validation ErrorHTTPValidationError

GET /api/orgs/{org_id}/members/invitations

Section titled “GET /api/orgs/{org_id}/members/invitations”

List Invitations

List all pending invitations for the organization.

Requires ADMIN or OWNER role.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseInvitationResponse[]
422Validation ErrorHTTPValidationError

PATCH /api/orgs/{org_id}/members/invitations/{invitation_id}

Section titled “PATCH /api/orgs/{org_id}/members/invitations/{invitation_id}”

Update Invitation

Change the role a pending invitation will grant on redemption.

The create-organization wizard sends every invite as MEMBER and lets the owner adjust roles afterwards, so this is the ordinary path rather than a correction: by then the invitation row already exists.

Requires ADMIN or OWNER; only an OWNER may raise an invitation to ADMIN or OWNER, matching invite_member.

Parameters

NameInTypeRequiredDescription
invitation_idpathstring (uuid)yes
org_idpathstring (uuid)yes

Request body (required)

FieldTypeRequiredDescription
rolestringyes

Responses

StatusDescriptionBody
200Successful ResponseInvitationResponse
422Validation ErrorHTTPValidationError

DELETE /api/orgs/{org_id}/members/invitations/{invitation_id}

Section titled “DELETE /api/orgs/{org_id}/members/invitations/{invitation_id}”

Revoke Invitation

Revoke a pending invitation.

Requires ADMIN or OWNER role. Only pending invitations can be revoked.

Parameters

NameInTypeRequiredDescription
invitation_idpathstring (uuid)yes
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
204Successful Response
422Validation ErrorHTTPValidationError

Invite Member

Add a user to the organization by email.

Requires ADMIN or OWNER role. If the user already has an account, they are added directly and a MemberResponse is returned. If they don’t have an account yet, a pending invitation is created and an InvitationResponse is returned (HTTP 201). When the user signs up, the invitation is redeemed automatically.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Request body (required)

FieldTypeRequiredDescription
emailstringyes
rolestringno

Responses

StatusDescriptionBody
201Successful ResponseMemberResponse | InvitationResponse
422Validation ErrorHTTPValidationError