Invitations

Get invitation details

Changed on

Look up an invitation by ID. Always 200 -- an unusable invitation is reported with valid: false and a reason rather than an error status.

get/invitation/{id}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/invitation/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

Invitation details

validboolean required

True only when the invitation can still be accepted.

errorstring

Why the invitation is unusable, when valid is false.

Changes

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 2ed51b8af657Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      added the non-success response with the status