Skip to main content
GET
/
invites
Get Invite By Email
curl --request GET \
  --url https://api.securegate.ai/invites \
  --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 looks up an invitation using an email address. It’s particularly useful when attendees need to find their own invitation or when you’re searching for someone by email rather than invite ID. What it does:
  • Finds an invitation using an email address instead of an ID
  • Can search within a specific event or across all events
  • Returns complete details about the matching invitation
When to use it:
  • When an attendee contacts you saying they lost their invitation
  • For customer support when helping attendees
  • When building a “look up your invitation” feature on your website
  • When searching for a specific person but you only have their email

​
Query Parameters

ParameterTypeRequiredDescription
emailstringYesThe email address of the invitee
event_idstringNoThe unique identifier of a specific event to search within

​
Response

The API returns the invite object that matches the specified email address: 
{
  "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"
}
Tip: If you don’t provide an event_id parameter, the API will search for the email across all events. This can be useful, but if you know which event you’re looking for, adding the event_id will make the search faster and more specific.

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
email
string
required
​
event_id
string | null

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