Invitations
List the invitations of the organization
Every invitation with its status (pending, accepted, expired or cancelled), email, role, who invited and when. Filter with status. Newest first. Read only: members.list shows only the people who already joined.
Required scope: invitations:read.
query Parameters
limitcursorThe nextCursor of the previous page, with the same filters.
statusHeaders
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
List the invitations of the organization › Responses
objecthasMorenextCursorInvite a person to the organization
Sends the invitation email with a link that lasts 7 days. The role is capped by the current role of the person who issued the key: the owner invites up to admin, an admin invites member or viewer, nobody invites as owner. If the email cannot be sent the invitation is created anyway and emailSent is false: resend it or check the address. The acceptance link is never returned. 409 if the email already joined or has a pending invitation. It is recorded in the audit log of members with the key.
Required scope: invitations:write.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Invite a person to the organization › Request Body
email^[A-Za-z0-9!#$%&'*+/… · requiredroleThe owner invites up to admin. An admin invites member or viewer. Nobody invites as owner.
Invite a person to the organization › Responses
objectidemailrolestatuspending can still be accepted. expired passed its 7 days: resend it to renew it. accepted already joined. cancelled can no longer be accepted.
invitedByThe member who invited, the same id members.list returns.
invitedAtWhen it was sent. Resending renews it.
expiresAtemailSentfalse when the email could not be sent. The invitation is created anyway: resend it with invitations.resend or ask the person to check the address. The acceptance link is never returned by the API.
Resend an invitation
Renews the 7 days and sends the email again with a new link: the previous link stops working. It works on pending and expired invitations. 409 if it was accepted or cancelled. It needs a role that can give the role of the invitation.
Required scope: invitations:write.
path Parameters
id^inv_[0-9A-Za-z]{22}… · requiredThe id of the invitation (inv_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Resend an invitation › Responses
objectidemailrolestatuspending can still be accepted. expired passed its 7 days: resend it to renew it. accepted already joined. cancelled can no longer be accepted.
invitedByThe member who invited, the same id members.list returns.
invitedAtWhen it was sent. Resending renews it.
expiresAtemailSentfalse when the email could not be sent. The invitation is created anyway: resend it with invitations.resend or ask the person to check the address. The acceptance link is never returned by the API.
Cancel an invitation
The link stops working and the invitation stays listed as cancelled. The same email can be invited again. 409 if it was already accepted or cancelled. It needs a role that can give the role of the invitation.
Required scope: invitations:write.
path Parameters
id^inv_[0-9A-Za-z]{22}… · requiredThe id of the invitation (inv_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Cancel an invitation › Responses
objectidemailrolestatuspending can still be accepted. expired passed its 7 days: resend it to renew it. accepted already joined. cancelled can no longer be accepted.
invitedByThe member who invited, the same id members.list returns.
invitedAtWhen it was sent. Resending renews it.
expiresAt