search

API Integrations

How to use the Event Vault API to manage guests and tickets.

Event Vault offers a simple REST API so you can automate guest and ticket management, or connect your event data to other systems. This guide explains how to authenticate, make requests, and use each endpoint with clear examples.

What You Can Do with the API

  • Add or remove guests
  • Add or remove tickets

All API requests are sent to https://api.event-vault.com and require authentication headers.

Authentication

Every request must include these headers:

Header Description
x-api-key Your supplied API key (keep this secret)
x-client-id Your client ID as shown in the system
x-event-id The ID of the event you want to manage

Example: Add a Guest (cURL)

Replace the placeholders with your actual API key, client ID, event ID, and request body.

curl "https://api.event-vault.com/addGuest" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "x-api-key: <your-api-key>" \
  -H "x-client-id: <your-client-id>" \
  -H "x-event-id: <your-event-id>" \
  -d '{
    "userEmail": "[email protected]",
    "name": "John Doe",
    "role": "Attendee",
    "company": "Example Corp"
  }'

Endpoints & Request Examples

Add Guest

  • Endpoint: POST /addGuest
  • Request Body:
{
  "userEmail": "[email protected]",
  "name": "John Doe",
  "role": "Attendee",
  "company": "Example Corp",
  "phone": "+1234567890",
  "url": "https://example.com",
  "country": "USA"
}

Remove Guest

  • Endpoint: POST /removeGuest
  • Request Body:
{
  "userEmail": "[email protected]"
}

Add Ticket

  • Endpoint: POST /addTicket
  • Request Body:
{
  "userEmail": "[email protected]",
  "ticketType": "ENTRY",
  "sessionId": ""
}

Remove Ticket

  • Endpoint: POST /removeTicket
  • Request Body:
{
  "userEmail": "[email protected]",
  "ticketType": "ENTRY"
}
← Publishing Analytics →