invites

Get a single invite by token

Changed on

Retrieve invite details including organization name by token

get/invites/{token}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

tokenstring required
Example:1234567890

Token of the invited user

Response

Returns the invite with organization details

idstring uuid required

Unique identifier of the invite

emailstring required

Email address of the invited user

role'admin' | 'manager' | 'user' required

Role assigned to the invited user

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

Current status of the invite

sentDatestring date-time required

Date when the invite was sent

expiresAtstring date-time required

Date when the invite expires

acceptedAtstring date-time

Date when the invite was accepted (if applicable)

orgIdstring uuid required

Organization the invitation belongs to

organizationNamestring required

Name of the organization

localPasswordLoginEnabledboolean required

Whether this organization accepts local password login

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "user@example.com",
  "role": "user",
  "status": "pending",
  "sentDate": "2023-12-01T10:00:00Z",
  "expiresAt": "2023-12-08T10:00:00Z",
  "acceptedAt": "2023-12-02T15:30:00Z",
  "orgId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationName": "Acme Corporation"
}

Changes

  • 95e3b90029a0Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status