auth

Read Invitation

GET

/api/auth/invite/{public_id}

Read Invitation

curl --request GET \
  --url '/api/auth/invite/{public_id}' \
  --header 'Authorization: Bearer <token>'

{
  "created": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "expires": "2023-11-07T05:31:56Z",
  "group_path": "<string>",
  "id": "5eb7cf5a86d9755df3a6c593",
  "public_id": "<string>",
  "role": "Administrator",
  "url": "<string>"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

public_idstringrequired

Response

Successful Response

createdstringrequired

emailstringrequired

expiresstringrequired

group_pathstringrequired

idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

public_idstringrequired

roleenum<string>required

Available options: Administrator, Editor, Operator, SubGroupAdministrator, SubGroupEditor, SubGroupOperator, SubGroupRestrictedOperator, ShareLinkOperator

urlstringrequired

Minimum string length: 1