Skip to main content
GET
/
events
/
{event_id}
/
invites
Get Invites
curl --request GET \
  --url https://api.securegate.ai/events/{event_id}/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>",
    "image": "<string>",
    "session_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_seen": "2023-11-07T05:31:56Z",
    "onyxplus_id": "<string>",
    "ticket_id": "<string>",
    "status": "pending"
  }
]
This endpoint lets you retrieve all the invitations you’ve sent for a specific event, with options to filter by status. What it does:
  • Retrieves all invitations for a particular event
  • Allows filtering by invitation status (pending, sent, accepted, rejected)
  • Provides complete information about each invite and its current status
When to use it:
  • To monitor invitation response rates
  • When following up with people who haven’t responded
  • To generate guest lists for accepted invitations
  • For reporting on invitation metrics

​
Path Parameters

ParameterTypeRequiredDescription
event_idstringYesThe unique identifier of the event

​
Query Parameters

ParameterTypeRequiredDescription
statusstringNoFilter invites by status. Options include: “pending”, “sent”, “accepted”, “rejected”

​
Response

The API returns an array of invite objects matching the specified criteria: 
[
  {
    "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"
  },
  {
    "id": "invite-124",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com",
    "country_code": "1",
    "mobile_number": "5559876543",
    "authentication_method": "Biometric",
    "event_id": "event-456",
    "session_code": "DEF456",
    "session_id": "session-790",
    "image": "https://example.com/profile-photos/jane-smith.jpg",
    "status": "pending",
    "created_at": "2023-02-28T12:01:00Z",
    "updated_at": "2023-02-28T12:01:00Z",
    "last_seen": null
  }
]
Invite status meanings:
  • pending: Invitation has been created but not sent yet
  • sent: Invitation has been sent but no response yet
  • accepted: Invitee has accepted the invitation
  • rejected: Invitee has declined the invitation
Tip: To get only accepted invitations (for creating a guest list), include ?status=accepted in your query.

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

​
event_id
string
required

Query Parameters

​
status
enum<string> | null
Available options:
pending,
sent,
accepted,
rejected

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>
Available options:
pending,
sent,
accepted,
rejected