InvitationsInvitation details

Invitation details

Full invitation data, INCLUDING the token (for copying the magic link). In a real system this should require authorization; it's skipped for the MVP.

curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/invitations/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "cmr3f41z20001psp7phmyapw3",
  "vaultId": "example_string",
  "email": "new@user.com",
  "status": "pending",
  "createdById": "example_string",
  "acceptedAt": "2026-07-02T11:25:15.134000Z",
  "acceptedUserId": "example_string",
  "revokedAt": "2026-07-02T11:25:15.134000Z",
  "createdAt": "2026-07-02T11:25:15.134000Z",
  "updatedAt": "2026-07-02T11:25:15.134000Z",
  "token": "a94aad35339dd6d3a5ca35e1b1ef2f78",
  "vault": {
    "id": "example_string",
    "code": "test_vault",
    "name": "John Doe"
  },
  "groupMemberships": [
    {
      "id": "cmr3f41z20001psp7phmyapw3",
      "invitationId": "example_string",
      "groupId": "example_string",
      "createdAt": "2026-07-02T11:25:15.134000Z",
      "group": {
        "id": "example_string",
        "code": "traders",
        "name": "John Doe"
      }
    }
  ],
  "createdBy": {
    "id": "example_string",
    "name": "John Doe",
    "email": "user@example.com"
  },
  "acceptedUser": {
    "id": "example_string",
    "name": "John Doe",
    "email": "user@example.com"
  }
}
GET
/api/v1/invitations/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Session token. Mobile/services. The web uses a cookie.

Session token. Mobile/services. The web uses a cookie.
API Key (cookie: session_token)
session_tokenstring
Required

API key (sent in cookie)

path
idstring
Required

Invitation id (cuid)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Session token. Mobile/services. The web uses a cookie.

path
parameterstring
Required

API Key for authentication. Provide your API key in the cookie.

Path Parameters

idstring
Required

Invitation id (cuid)

Responses

idstring
Required

cuid

vaultIdstring
Required
emailstring
Required
statusstring
Required

Lifecycle: pending → accepted | revoked

Allowed values:pendingacceptedrevoked
createdByIdstring
Required
acceptedAtstring
Required
acceptedUserIdstring
Required
revokedAtstring
Required
createdAtstring
Required
updatedAtstring
Required
tokenstring
Required

Magic link secret (32 hex). Returned only on create and in GET /:id

vaultobject
Required
groupMembershipsarray
Required
createdBystring
Required
acceptedUserstring
Required