Get invite link

Get an invite link by its code. Public endpoint used by the invite acceptance page.

GET /api/v1/invite-links/{inviteLinkCode}

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "email": "<string>",
    "userUuid": "<string>",
    "organizationUuid": "<string>",
    "inviteUrl": "<string>",
    "inviteCode": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

inviteLinkCode · string · required

the code of the invite link

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok