Skip to main content
GET
/
invites
/
{invite_id}
Get Invite By Id
curl --request GET \
  --url https://api.securegate.ai/invites/{invite_id} \
  --header 'x-api-key: <api-key>'
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "country_code": "1",
  "mobile_number": "<string>",
  "authentication_method": "QR Code",
  "id": "<string>",
  "event_id": "<string>",
  "session_code": "<string>",
  "session_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "image": "<string>",
  "last_seen": "2023-11-07T05:31:56Z",
  "onyxplus_id": "<string>",
  "ticket_id": "<string>",
  "status": "pending"
}

Documentation Index

Fetch the complete documentation index at: https://docs.securegate.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

ParameterTypeRequiredDescription
invite_idstringYesThe unique identifier of the invite

​
Response

The API returns the invite object with all its details: 
{
  "id": "invite-123",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "country_code": "1",
  "mobile_number": "5551234567",
  "authentication_method": "QR Code",
  "event_id": "event-456",
  "session_code": "ABC123",
  "session_id": "session-789",
  "image": "https://example.com/profile-photos/john-doe.jpg",
  "status": "accepted",
  "created_at": "2023-02-28T12:00:00Z",
  "updated_at": "2023-03-01T09:30:00Z",
  "last_seen": "2023-03-01T10:15:00Z",
  "onyxplus_id": "onyx-123",
  "ticket_id": "ticket-456"
}
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