Events

Get All Events

Retrieves a paginated list of events for your account. Returns event configuration, scheduling, and status information.

Use fields to control which fields are returned (defaults to id, name when not specified). Use expand to include related objects: folder, location.

Use expand=capacityRemaining to include the number of places left (the event capacity minus confirmed, attended, no-show, in-progress, allocated and waitlisted registrants and pending ticket seats, ignoring reg types excluded from event capacity). The value is an integer, or null when the event has no capacity (a capacity of 0 or unset means unlimited). It is calculated per event, so request it only when needed and keep per-page small. It cannot be used in search or sort.

Use search to filter by any event field (e.g., status=live, start_date>=2025-01-01, name=*conference*). Supports operators: =, !=, >=, <=, >, <, *contains*, *beginswith*, *endswith*. Results are paginated with a maximum of 200 per page.

GET

events

cURL

curl -X GET "https://api.swoogo.com/api/v1/events?fields=id,name,status,start_date,end_date&search=status%3Dlive&sort=-start_date" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch(
  'https://api.swoogo.com/api/v1/events?fields=id,name,status,start_date&search=status%3Dlive',
  { headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' } }
);
const { items } = await response.json();

import requests

response = requests.get(
    "https://api.swoogo.com/api/v1/events",
    params={"fields": "id,name,status,start_date", "search": "status=live"},
    headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"},
)
events = response.json()["items"]

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swoogo.com/api/v1/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data; boundary=---011000010111000001101001"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swoogo.com/api/v1/events"

	payload := strings.NewReader("-----011000010111000001101001\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")

	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.swoogo.com/api/v1/events")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
  .body("-----011000010111000001101001\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.swoogo.com/api/v1/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "created_at": "2023-04-21 15:46:23",
      "updated_at": "2023-04-21 15:47:37"
    }
  ],
  "_links": {
    "self": {
      "href": ""
    },
    "first": {
      "href": ""
    },
    "last": {
      "href": ""
    }
  },
  "_meta": {
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "code": 0,
  "status": 401
}

{
  "name": "Forbidden",
  "message": "You do not have access to that resource.",
  "code": 0,
  "status": 403
}

{
  "name": "Not Found",
  "message": "The requested resource does not exist.",
  "code": 0,
  "status": 404
}

{
  "name": "Internal Server Error",
  "message": "An error occurred while processing your request.",
  "code": 0,
  "status": 500
}

Authorizations

Authorization

string

header

required

OAuth 2.0 bearer token obtained from POST /oauth2/token. Tokens expire after 30 minutes. Include in the Authorization header as Bearer {access_token}.

Query Parameters

fields

string

string - optional - Comma separated list of fields you want to return

Example:

"capacity,close_date,close_time,created_at,created_by,description,domain,end_date,end_time,folder_id,free_event,hashtag,id,name,organizer_id,start_date,start_time,status,target_attendance,timezone,type_id,updated_at,updated_by,url,webinar_url"

expand

string

string - optional - Comma separated list of related objects to include. Valid values: folder, location, sessions, sponsors, speakers, translations, capacityRemaining

Example:

"folder,location"

string

string - optional - Filter conditions to narrow the results. Valid operators are =, !=, >=, <=, >, <, contains, beginswith, endswith

Example:

"id>123"

page

string

integer - optional - The page of results you want to view

Example:

"1"

per-page

string

integer - optional - The number of results per page (to a max of 200)

Example:

"5"

sort

string

string - optional - Sort the results (add - in front for opposite sort direction, e.g. "-id")

ids

string

Comma-separated list of IDs to retrieve. When provided, only records matching these IDs are returned. All values must be positive integers. Maximum 100 IDs per request.

Body

multipart/form-data

The body is of type object.

Response

Collection

items

object[]

Show child attributes

_links

object

Show child attributes

_meta

object

Show child attributes

⌘I

cURL

curl -X GET "https://api.swoogo.com/api/v1/events?fields=id,name,status,start_date,end_date&search=status%3Dlive&sort=-start_date" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch(
  'https://api.swoogo.com/api/v1/events?fields=id,name,status,start_date&search=status%3Dlive',
  { headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' } }
);
const { items } = await response.json();

import requests

response = requests.get(
    "https://api.swoogo.com/api/v1/events",
    params={"fields": "id,name,status,start_date", "search": "status=live"},
    headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"},
)
events = response.json()["items"]

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swoogo.com/api/v1/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data; boundary=---011000010111000001101001"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swoogo.com/api/v1/events"

	payload := strings.NewReader("-----011000010111000001101001\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")

	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.swoogo.com/api/v1/events")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
  .body("-----011000010111000001101001\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.swoogo.com/api/v1/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "created_at": "2023-04-21 15:46:23",
      "updated_at": "2023-04-21 15:47:37"
    }
  ],
  "_links": {
    "self": {
      "href": ""
    },
    "first": {
      "href": ""
    },
    "last": {
      "href": ""
    }
  },
  "_meta": {
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "code": 0,
  "status": 401
}

{
  "name": "Forbidden",
  "message": "You do not have access to that resource.",
  "code": 0,
  "status": 403
}

{
  "name": "Not Found",
  "message": "The requested resource does not exist.",
  "code": 0,
  "status": 404
}

{
  "name": "Internal Server Error",
  "message": "An error occurred while processing your request.",
  "code": 0,
  "status": 500
}

Overview

API endpoints

Get All Events

Authorizations

Query Parameters

Body

Response