# Retrieve an Invitation

Returns an invitation by id. You can read invitations belonging to the authenticated client or any of its descendants. 
Invitations outside your hierarchy are treated the same as invitations that don’t exist, so both return not_found (404).

Use this to check whether an invitation has been accepted (accepted_at) or to retrieve its acceptance URL again.


Endpoint: GET /v2/invitations/{id}
Security: Bearer-Auth

## Path parameters:

  - `id` (string, required)

## Response 200 fields (application/json):

  - `id` (string, required)
    The invitation's unique identifier (UUID).

  - `client_id` (string, required)
    The UUID of the sub-client the user is being invited into. Always a descendant of the authenticated client — never the authenticated client itself.

  - `user_email` (string, required)
    The email address the invitation was issued to. Normalized (trimmed and lower-cased) on creation.

  - `first_name` (string,null)
    The invited user's first name, if provided.

  - `last_name` (string,null)
    The invited user's last name, if provided.

  - `role` (string, required)
    The role the invited user will hold in the sub-client. One of the client-level roles
(for example  or ). SQUAKE-internal roles cannot be assigned via the API.

  - `locale` (string, required)
    The language used for the invitation email and acceptance page.
    Enum: "en", "de", "fr"

  - `sent_at` (string,null)
    When the invitation email was last sent. Updated on every resend.

  - `accepted_at` (string,null, required)
    When the invited user accepted the invitation, or  if it is still outstanding.

  - `invitation_url` (string,null, required)
    The acceptance URL the invited user follows to set a password and finish signing up. Stable across resends.

## Response 401 fields (application/json):

  - `errors` (array)

  - `errors.code` (string, required)
    An application-specific error code, expressed as a string value.
    Enum: "field_validation_error", "invalid_params", "server_error", "not_authorized", "not_found", "invalid_methodology", "invalid_type", "client_not_found", "invalid_parent_client", "client_has_children", "parent_id_immutable", "travel_data_not_found"

  - `errors.detail` (string)
    A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

  - `errors.source` (object)
    An object containing references to the primary source of the error

  - `errors.source.id` (string)

  - `errors.source.attribute` (string, required)

  - `errors.source.model` (string)

## Response 404 fields (application/json):

  - `errors` (array)

  - `errors.code` (string, required)
    An application-specific error code, expressed as a string value.
    Enum: "field_validation_error", "invalid_params", "server_error", "not_authorized", "not_found", "invalid_methodology", "invalid_type", "client_not_found", "invalid_parent_client", "client_has_children", "parent_id_immutable", "travel_data_not_found"

  - `errors.detail` (string)
    A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

  - `errors.source` (object)
    An object containing references to the primary source of the error

  - `errors.source.id` (string)

  - `errors.source.attribute` (string, required)

  - `errors.source.model` (string)