Get Event With Stats
curl --request GET \
--url https://api.securegate.ai/events/{event_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.securegate.ai/events/{event_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/events/{event_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/events/{event_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/events/{event_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/events/{event_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/events/{event_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{
"id": "<string>",
"description": "<string>",
"instructions": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"status": "<string>",
"type": "fixed",
"location": {
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>"
},
"is_deleted": true,
"invite_stats": {
"sent": 123,
"accepted": 123,
"pending": 123,
"rejected": 123,
"total": 123
},
"start_timestamp": 123,
"end_timestamp": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Event Management
Get Event With Stats
Get a single event by ID with invitation statistics
GET
/
events
/
{event_id}
Get Event With Stats
curl --request GET \
--url https://api.securegate.ai/events/{event_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.securegate.ai/events/{event_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/events/{event_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/events/{event_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/events/{event_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/events/{event_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/events/{event_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{
"id": "<string>",
"description": "<string>",
"instructions": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"status": "<string>",
"type": "fixed",
"location": {
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>"
},
"is_deleted": true,
"invite_stats": {
"sent": 123,
"accepted": 123,
"pending": 123,
"rejected": 123,
"total": 123
},
"start_timestamp": 123,
"end_timestamp": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}This endpoint retrieves detailed information about a specific event, including statistics about invitations. It’s perfect for building event dashboards and monitoring attendance.
What it does:
The
- Fetches complete information about a single event using its ID
- Provides statistics about invitations (sent, accepted, pending, rejected)
- Shows you the current status of your event and its attendance metrics
- When building an event management dashboard
- When you need to monitor invitation response rates
- When checking how many people have accepted your invitations
- Before an event to assess expected attendance
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
event_id | string | Yes | The unique identifier of the event to retrieve |
Response
The API returns the event object with all its details, including invitation statistics:{
"id": "event-123",
"description": "Join us for the annual tech conference featuring speakers from top tech companies",
"instructions": "Please arrive 30 minutes before the event starts for registration",
"title": "Annual Tech Conference",
"imageUrl": "https://example.com/event-image.jpg",
"status": "upcoming",
"type": "dated",
"location": {
"address": "123 Conference Center Dr",
"city": "San Francisco",
"state": "CA",
"zipCode": "94105",
"country": "USA"
},
"start_timestamp": 1677609600,
"end_timestamp": 1677696000,
"is_deleted": false,
"invite_stats": {
"sent": 150,
"accepted": 75,
"pending": 50,
"rejected": 25,
"total": 150
}
}
invite_stats field shows you:
- How many invitations were sent total (
total) - How many people have accepted your invitation (
accepted) - How many haven’t responded yet (
pending) - How many declined to attend (
rejected)
Authorizations
API key authentication. Add your API key as the value of the 'x-api-key' header.
Path Parameters
Response
Successful Response
Available options:
fixed, dated Show child attributes
Show child attributes
Show child attributes
Show child attributes
