Get Invite By Id
curl --request GET \
--url https://api.securegate.ai/invites/{invite_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.securegate.ai/invites/{invite_id}"
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/invites/{invite_id}', 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/invites/{invite_id}",
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/invites/{invite_id}"
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/invites/{invite_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/invites/{invite_id}")
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 Invite By ID
Get invite details for a single person by invite ID
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>'import requests
url = "https://api.securegate.ai/invites/{invite_id}"
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/invites/{invite_id}', 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/invites/{invite_id}",
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/invites/{invite_id}"
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/invites/{invite_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/invites/{invite_id}")
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 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:
Key information in the response:
- 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 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
| Parameter | Type | Required | Description |
|---|---|---|---|
invite_id | string | Yes | The 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"
}
session_code: The unique code needed for QR-based check-inauthentication_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
API key authentication. Add your API key as the value of the 'x-api-key' header.
Path Parameters
Response
Successful Response
Available options:
1, 44, 1, 61, 91, 345 Available options:
QR Code, Biometric, Both Available options:
pending, sent, accepted, rejected 