An invitation, from the link in its email: the organization, the role and the invited address, masked. No credential; the token is the credential

get/v1/invitations/{token}

Request

  • Base URL: https://api.evictionsapi.com
  • URL: https://api.evictionsapi.com/v1/invitations/{token}
  • Auth: none required

Path parameters

tokenstring required

Response

The invitation. accountExists says whether the invited address already has an account (then the person signs in to accept).

organizationNamestring required
role'owner' | 'member' | 'viewer' required
emailMaskedstring required

The first letter and the domain of the invited address, such as s•••@example.com.

accountExistsboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.