Get Invites
curl --request GET \
--url https://api.securegate.ai/events/{event_id}/invites \
--header 'x-api-key: <api-key>'import requests
url = "https://api.securegate.ai/events/{event_id}/invites"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.securegate.ai/events/{event_id}/invites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.securegate.ai/events/{event_id}/invites",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.securegate.ai/events/{event_id}/invites"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.securegate.ai/events/{event_id}/invites")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/events/{event_id}/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"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"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Invite Management
Get Invites
Get all invites for an event with optional status filtering
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>'import requests
url = "https://api.securegate.ai/events/{event_id}/invites"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.securegate.ai/events/{event_id}/invites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.securegate.ai/events/{event_id}/invites",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.securegate.ai/events/{event_id}/invites"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.securegate.ai/events/{event_id}/invites")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/events/{event_id}/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"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"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}This endpoint lets you retrieve all the invitations you’ve sent for a specific event, with options to filter by status.
What it does:
Invite status meanings:
- 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
- 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
| Parameter | Type | Required | Description |
|---|---|---|---|
event_id | string | Yes | The unique identifier of the event |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter 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
}
]
pending: Invitation has been created but not sent yetsent: Invitation has been sent but no response yetaccepted: Invitee has accepted the invitationrejected: Invitee has declined the invitation
?status=accepted in your query.Authorizations
API key authentication. Add your API key as the value of the 'x-api-key' header.
Path Parameters
Query Parameters
Available options:
pending, sent, accepted, rejected Response
Successful Response
Available options:
1, 44, 1, 61, 91, 345 Available options:
QR Code, Biometric, Both Available options:
pending, sent, accepted, rejected 