v2

latestOpenAPI 3.0.0MITraw.githubusercontent.com2024-10-1794217620.9 KB
Invites

Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.

post/organization/invites

Request body

emailstring required

Send an email to this address

role'reader' | 'owner' required

owner or reader

Response

User invited successfully.

object'organization.invite' required

The object type, which is always organization.invite

idstring required

The identifier, which can be referenced in API endpoints

emailstring required

The email address of the individual to whom the invite was sent

role'owner' | 'reader' required

owner or reader

status'accepted' | 'expired' | 'pending' required

accepted,expired, or pending

invited_atinteger required

The Unix timestamp (in seconds) of when the invite was sent.

expires_atinteger required

The Unix timestamp (in seconds) of when the invite expires.

accepted_atinteger

The Unix timestamp (in seconds) of when the invite was accepted.