Retrieve an Invitation
Changed Sep 4Returns 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.
Bearer-AuthAuthorizationBearer <token>id*stringuuidOK
application/json- response
An invitation to a user of a sub-client of the authenticated client, as returned by the
/v2/invitations endpoints. Each invitation is tied to exactly one user in exactly one client;
re-inviting the same address to the same sub-client returns the invitation that already exists
with an updated sent_at, not a new one.
The invitation_url is the acceptance link the invited user receives by email. Persist the
id if you want to look the invitation up again later; both the id and invitation_url are
stable across resends.
id*stringThe invitation's unique identifier (UUID).
uuidclient_id*stringThe UUID of the sub-client the user is being invited into. Always a descendant of the authenticated client — never the authenticated client itself.
uuiduser_email*stringThe email address the invitation was issued to. Normalized (trimmed and lower-cased) on creation.
emailfirst_name?|The invited user's first name, if provided.
last_name?|The invited user's last name, if provided.
role*stringThe role the invited user will hold in the sub-client. One of the client-level roles
(for example admin or user). SQUAKE-internal roles cannot be assigned via the API.
locale*stringThe language used for the invitation email and acceptance page.
"en""de""fr"sent_at?|When the invitation email was last sent. Updated on every resend.
date-timeaccepted_at*|When the invited user accepted the invitation, or null if it is still outstanding.
date-timeinvitation_url*|The acceptance URL the invited user follows to set a password and finish signing up. Stable across resends.
uricurl -X GET 'https://api.sandbox.squake.earth/v2/invitations/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "8f6a1c9c-3f28-4b3e-9a1b-24a0f0c7f5b1", "client_id": "4fb3ec7a-92cb-471f-b75f-c3fe7c2a34d5", "user_email": "ada.lovelace@example.com", "first_name": "Ada", "last_name": "Lovelace", "role": "admin", "locale": "de", "sent_at": "2026-08-31T10:23:14Z", "accepted_at": null, "invitation_url": "https://app.squake.earth/accept-invite/6b3a2e1c-9e5d-4b7a-b0f8-2c8f6a4d1e11?token=eyJhbGciOi..."}Readyz
Extensive health check to verify SQUAKE's server can be reached; this additionally checks all sub-dependencies, such as database systems, and also considers the error rate of the most recent history. Meaning even if SQUAKE's servers are reachable, including their sub-systems, if other clients experience excessively many errors, this endpoint returns an error.
Invite a User
Invites a user to one of the authenticated client's sub-clients. The user is created if they don't already exist, or reused if the email address already belongs to a user of that sub-client. An invitation email is then queued. This endpoint only supports sub-clients: `client_id` must refer to a sub-client of the authenticated client. You can't invite users to the authenticated client itself. Omitting `client_id` also targets the authenticated client (as it does elsewhere in v2), so both cases return `client_not_invitable` (`403`). To manage users in your own organization, use the SQUAKE Dashboard. Re-inviting the same email address for the same sub-client is safe. The existing invitation is returned with an updated `sent_at`, and the email is sent again. The acceptance URL stays the same, so any previously sent invitation link will continue to work. If `locale` is omitted when re-inviting a user, the locale from the previous invitation is preserved.