Retrieve an invitation

Check whether an invited user has accepted, or read the invitation link again.

Returns one invitation by its ID. Use it to check whether the user has accepted (accepted_at) or to read the invitation_url again. You can read the invitations of the authenticated client and all of its descendants.

Request

GET /v2/invitations/{id}

idstring (UUID)required

The invitation's ID, as returned by Invite a user.

See every field of GET /v2/invitations/{id} in the API reference
curl "https://api.sandbox.squake.earth/v2/invitations/8f6a1c9c-3f28-4b3e-9a1b-24a0f0c7f5b1" \
  --header "Authorization: Bearer $SQUAKE_API_KEY"

Response

This user accepted the invitation two days after it was sent:

200 OKapplication/json
{
  "id": "8f6a1c9c-3f28-4b3e-9a1b-24a0f0c7f5b1",
  "client_id": "4fb3ec7a-92cb-471f-b75f-c3fe7c2a34d5",
  "user_email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "role": "user",
  "locale": "de",
  "sent_at": "2026-08-31T10:23:14Z",
  "accepted_at": "2026-09-02T14:07:52Z",
  "invitation_url": "https://app.squake.earth/accept-invite/6b3a2e1c-9e5d-4b7a-b0f8-2c8f6a4d1e11?token=eyJhbGciOi..."
}

accepted_at is null while the invitation is open. For every field, see Invite a user.

Errors

StatusCodeMeaning
401The API key is missing or invalid.
404not_foundNo invitation has this ID, or the invitation belongs to a client outside your hierarchy.

An invitation outside your hierarchy returns the same response as one that doesn't exist.

On this page

GET/v2/invitations/{id}

Run this request against the sandbox with your test key.

Open in API reference