Sign in
Invites

Create invite

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

created_atinteger required

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

expires_atinteger nullable

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

accepted_atinteger nullable

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

Changes

Changed in 4 of the 163 revisions of this API.411

  • d86203de41ae3See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 74cbcf73838f45See the full diff
    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      response property accepted_at list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property expires_at list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ○

      the endpoint scheme security AdminApiKeyAuth was added to the API

      api-security-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d311deacd11a2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 8eca3b09b7051See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog