Registrants

Get All Registrants

Retrieves a paginated list of registrants for a specific event. Returns registrant profile data, registration status, and financial summaries.

Requires event_id as a query parameter. Use fields to control which fields are returned (defaults to id, first_name, last_name when not specified). Use expand to include related address objects: homeAddress, workAddress, billingAddress.

Use search to filter by any registrant field (e.g., registration_status=confirmed, email=*@example.com*). Supports operators: =, !=, >=, <=, >, <, *contains*, *beginswith*, *endswith*. Maximum 200 results per page with per-page, or up to 1000 per page when no expand is used.

GET

registrants

cURL

curl -X GET "https://api.swoogo.com/api/v1/registrants?event_id=123&fields=id,email,first_name,last_name,registration_status&search=registration_status%3Dconfirmed&per-page=50" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const params = new URLSearchParams({
  event_id: '123',
  fields: 'id,email,first_name,last_name,registration_status',
  search: 'registration_status=confirmed',
  'per-page': '50',
});

const response = await fetch(
  `https://api.swoogo.com/api/v1/registrants?${params}`,
  { headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' } }
);

const { items, _meta } = await response.json();
console.log(`Page ${_meta.currentPage} of ${_meta.pageCount} (${_meta.totalCount} total)`);

import requests

response = requests.get(
    "https://api.swoogo.com/api/v1/registrants",
    params={
        "event_id": 123,
        "fields": "id,email,first_name,last_name,registration_status",
        "search": "registration_status=confirmed",
        "per-page": 50,
    },
    headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"},
)

data = response.json()
for registrant in data["items"]:
    print(f"{registrant['first_name']} {registrant['last_name']} - {registrant['email']}")

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swoogo.com/api/v1/registrants",
  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/registrants"

	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/registrants")
  .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/registrants")

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

event_id

integer

required

integer - required - The ID of the event you want to retrieve registrants for

Example:

1

fields

string

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

Example:

"id,event_id,group_id,reg_type_id,package_id,discount_code,email,prefix,first_name,middle_name,last_name,suffix,company,job_title,work_phone,mobile_phone,profile_picture,twitter_handle,gender,birth_date,cc_email,bio,vat_number,contact_id,session_ids,waitlisted_session_ids,notes,reference,ip_address,individual_net,individual_tax,individual_tax_2,individual_gross,group_net,group_tax,group_tax_2,group_gross,group_paid,created_at,updated_at,registered_at,cancelled_at,checked_in_at,ext_token,secure_id,timezone,registration_status,language,payment_method,po_number,group_balance_due,payment_status"

expand

string

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

Example:

"homeAddress,workAddress,billingAddress"

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/registrants?event_id=123&fields=id,email,first_name,last_name,registration_status&search=registration_status%3Dconfirmed&per-page=50" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const params = new URLSearchParams({
  event_id: '123',
  fields: 'id,email,first_name,last_name,registration_status',
  search: 'registration_status=confirmed',
  'per-page': '50',
});

const response = await fetch(
  `https://api.swoogo.com/api/v1/registrants?${params}`,
  { headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' } }
);

const { items, _meta } = await response.json();
console.log(`Page ${_meta.currentPage} of ${_meta.pageCount} (${_meta.totalCount} total)`);

import requests

response = requests.get(
    "https://api.swoogo.com/api/v1/registrants",
    params={
        "event_id": 123,
        "fields": "id,email,first_name,last_name,registration_status",
        "search": "registration_status=confirmed",
        "per-page": 50,
    },
    headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"},
)

data = response.json()
for registrant in data["items"]:
    print(f"{registrant['first_name']} {registrant['last_name']} - {registrant['email']}")

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swoogo.com/api/v1/registrants",
  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/registrants"

	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/registrants")
  .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/registrants")

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 Registrants

Authorizations

Query Parameters

Body

Response