Preview invitation details (public)

GET /api/v1/invitations/{token}/preview

Returns non-sensitive invitation details for rendering the invite signup page. No authentication required -- the token itself is the proof.

Operation ID: preview_invitation_api_v1_invitations__token__preview_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

token string required

Responses

200 Successful Response

Schema: InvitationPreviewResponse

status string required: One of: pending, expired, accepted, cancelled, not_found
invitation_type string
firm_name string
firm_logo_url string
invitee_email string
invitee_first_name string
invitee_last_name string
role string

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/invitations/{token}/preview

bash

curl -X GET 'https://api.ondayzero.com/api/v1/invitations/{token}/preview' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/invitations/{token}/preview', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/invitations/{token}/preview", headers=headers)
data = response.json()