v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-03124241726.5 KB

Members

Invite a member

Signals an invitation to join the caller's organization. The invitee receives an accept link by email and becomes a member once they accept. The response is the pending invitation record. Requires OAuth authentication (API-key callers can't act on behalf of a specific user).

post/v1/members

Request body

emailstring email required

Email address to invite. The invitee receives an accept link by email.

role'owner' | 'admin' | 'member'

Role to grant on acceptance. Defaults to member when omitted.

Response

Invitation created

status'invited' required

Discriminator for pending invitations — the invitee hasn't accepted yet, so no user record exists.

idstring required

Stable invitation identifier. Distinct from membership ids.

organizationIdstring required

Organization the invitation grants access to.

{"stackTrail":"components:schemas:InvitedMember:properties:userId","oasType":"schema","type":"unknown","description":"Always `null` — no user record exists until the invitation is accepted."}

role'owner' | 'admin' | 'member' | 'null' nullable required

Role the invitee will get once they accept. null means the default (member).

{"stackTrail":"components:schemas:InvitedMember:properties:name","oasType":"schema","type":"unknown","description":"Always `null` — no user record exists yet."}

emailstring required

Email address the invitation was sent to.

{"stackTrail":"components:schemas:InvitedMember:properties:image","oasType":"schema","type":"unknown","description":"Always `null` — no user record exists yet."}

invitedAtstring required

ISO-8601 timestamp at which the invitation was created.

expiresAtstring required

ISO-8601 timestamp at which the invitation expires.

inviterIdstring required

User id of the member who issued the invitation.