Get Invite With Event

curl --request GET \
  --url https://api.securegate.ai/invites-with-event \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.securegate.ai/invites-with-event', 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-with-event",
  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-with-event"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.securegate.ai/invites-with-event")

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

{
  "invite": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "mobile_number": "<string>",
    "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"
  },
  "event": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

invites-with-event

Get Invite With Event

curl --request GET \
  --url https://api.securegate.ai/invites-with-event \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.securegate.ai/invites-with-event', 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-with-event",
  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-with-event"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.securegate.ai/invites-with-event")

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

{
  "invite": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "mobile_number": "<string>",
    "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"
  },
  "event": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

This endpoint retrieves both invitation details and information about the associated event in a single call. It’s perfect for creating attendee-facing interfaces where you need to show both the invitation and event information. What it does:

Fetches an invitation and its associated event details in one request
Can find the invitation using either a session ID or invite ID
Returns comprehensive information about both the invitation and the event

When to use it:

When building user-facing invitation portals
For creating digital tickets that show event details
When displaying “Your Invitations” screens in an app
To get complete context about an invitation and its event

Query Parameters

Parameter	Type	Required	Description
`session_id`	string	No	The unique session identifier
`invite_id`	string	No	The unique invite identifier

You must provide either session_id or invite_id, but not necessarily both.

Response

The API returns a response object containing the invite details and its associated event information:

{
  "invite": {
    "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"
  },
  "event": {
    "id": "event-456",
    "title": "Annual Tech Conference",
    "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",
    "imageUrl": "https://example.com/event-image.jpg",
    "location": {
      "address": "123 Conference Center Dr",
      "city": "San Francisco",
      "state": "CA",
      "zipCode": "94105",
      "country": "USA"
    },
    "start_timestamp": 1677609600,
    "end_timestamp": 1677696000,
    "type": "dated"
  }
}

Efficiency note: This endpoint combines what would otherwise be two separate API calls (getting invite details and getting event details), making your application more efficient and providing a better user experience.

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

session_id

string | null

invite_id

string | null

Response

Successful Response

invite

Invite · object

required

Show child attributes

event

Event · object | null

API Documentation

Event Management

Invite Management

Identity Verification

Get Invite With Event

Query Parameters

Response

Authorizations

Query Parameters

Response

​Query Parameters

​Response

Authorizations

Query Parameters

Response

Query Parameters

Response