Skip to main content
GET
Get Invite By Id
This endpoint retrieves detailed information about a specific invitation using its unique ID. It’s useful when you need to check the status of a particular invite or view its details. What it does:
  • Fetches complete information about a single invitation
  • Returns all details including contact information, status, and tracking data
  • Provides the unique codes needed for check-in
When to use it:
  • When checking the status of a specific invitation
  • When troubleshooting issues with a particular invitee
  • For retrieving an individual’s invitation details at check-in
  • When you need to verify if someone was invited

Path Parameters

Response

The API returns the invite object with all its details:
Key information in the response:
  • session_code: The unique code needed for QR-based check-in
  • authentication_method: How this person will be verified (QR Code, Biometric, or Both)
  • status: Current status of the invitation (pending, sent, accepted, rejected)
  • last_seen: When this person was last active with their invitation

Authorizations

x-api-key
string
header
required

API key authentication. Add your API key as the value of the 'x-api-key' header.

Path Parameters

invite_id
string
required

Response

Successful Response

first_name
string
required
last_name
string
required
email
string
required
country_code
enum<string>
required
Available options:
1,
44,
1,
61,
91,
345
mobile_number
string
required
authentication_method
enum<string>
required
Available options:
QR Code,
Biometric,
Both
id
string
required
event_id
string
required
session_code
string
required
session_id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
image
string | null
last_seen
string<date-time> | null
onyxplus_id
string | null
ticket_id
string | null
status
enum<string>
default:pending
Available options:
pending,
sent,
accepted,
rejected