Skip to main content
GET
/
events
Get All Events
curl --request GET \
  --url https://api.securegate.ai/events \
  --header 'x-api-key: <api-key>'
{
  "ongoing": [
    {
      "title": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "imageUrl": "<string>",
      "location": {
        "address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>"
      },
      "start_timestamp": 123,
      "end_timestamp": 123,
      "type": "fixed",
      "is_deleted": true,
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "ended": [
    {
      "title": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "imageUrl": "<string>",
      "location": {
        "address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>"
      },
      "start_timestamp": 123,
      "end_timestamp": 123,
      "type": "fixed",
      "is_deleted": true,
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "up_coming": [
    {
      "title": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "imageUrl": "<string>",
      "location": {
        "address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>"
      },
      "start_timestamp": 123,
      "end_timestamp": 123,
      "type": "fixed",
      "is_deleted": true,
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "archived": [
    {
      "title": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "imageUrl": "<string>",
      "location": {
        "address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>"
      },
      "start_timestamp": 123,
      "end_timestamp": 123,
      "type": "fixed",
      "is_deleted": true,
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}
This endpoint gives you a complete list of all events in your account, organized by their current status. It’s usually the first API you’ll call when building an event dashboard or management interface. What it does:
  • Returns all your events, sorted into categories (ongoing, upcoming, ended, archived)
  • Provides complete details for each event including location, times, and settings
  • Helps you track which events are active and which have concluded
When to use it:
  • When building an event management dashboard
  • When you need to display a list of events to users
  • To monitor the status of all your events at once

​
Authentication

This endpoint requires authentication using an API key. Add the following header to your request: 
x-api-key: YOUR_API_KEY
To obtain an API key, please contact our support team.

​
Response

The response contains a list of all events organized by their status (ongoing, ended, up_coming, archived). Each event includes its complete details including title, description, location, and timestamps. 
{
  "ongoing": [
    {
      "title": "Annual Conference 2023",
      "description": "Technology industry conference",
      "instructions": "Check-in opens at 8:00 AM",
      "imageUrl": "https://example.com/images/events/annual-conference.png",
      "location": {
        "address": "123 Convention Center Way",
        "city": "San Francisco",
        "state": "CA",
        "zipCode": "94103",
        "country": "USA"
      },
      "start_timestamp": 1683730000000,
      "end_timestamp": 1683816400000,
      "type": "dated",
      "is_deleted": false,
      "id": "evt_abc123def456",
      "created_at": "2023-01-15T10:30:00.000000",
      "updated_at": "2023-01-15T10:30:00.000000"
    },
    {
      "title": "Tech Expo",
      "description": "Product showcase and demonstrations",
      "instructions": "Bring ID for security clearance",
      "imageUrl": "https://example.com/images/events/tech-expo.png",
      "location": {
        "address": "456 Innovation Blvd",
        "city": "New York",
        "state": "NY",
        "zipCode": "10001",
        "country": "USA"
      },
      "start_timestamp": 1684334800000,
      "end_timestamp": 1684421200000,
      "type": "dated",
      "is_deleted": false,
      "id": "evt_ghi789jkl012",
      "created_at": "2023-02-10T14:15:00.000000",
      "updated_at": "2023-02-10T14:15:00.000000"
    }
  ],
  "ended": [],
  "up_coming": [],
  "archived": []
}
Each event category contains an array of event objects. If there are no events in a particular category, an empty array is returned for that category.

​
Example Request with cURL

curl -X GET https://api.securegate.ai/events \
  -H "x-api-key: YOUR_API_KEY"

Authorizations

​
x-api-key
string
header
required

API key authentication. Add your API key as the value of the 'x-api-key' header.

Response

200 - application/json

Successful Response

​
ongoing
Event · object[]

Currently active events

​
ended
Event · object[]

Events that have ended

​
up_coming
Event · object[]

Events that will start in the future

​
archived
Event · object[]

Archived events