Skip to main content
GET
Get All Packages

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 packages for

Example:

1

fields
string

string - optional - Comma separated list of fields you want to return. When omitted, only id, name, and capacity are returned.

Example:

"id,name,public_short_name,admin_short_name,description,capacity,sold_out_message,min_group_size,max_group_size,created_at,updated_at"

expand
string

string - optional - Comma separated list of related objects to embed in each item. Supported values are fees, earlyBirds, and translations.

Example:

"fees"

string - optional - Filter conditions to narrow the results. Valid operators are =, !=, >=, <=, >, <, contains, beginswith, endswith. Searchable fields are id, name, public_short_name, admin_short_name, description, capacity, min_group_size, max_group_size, created_at, and updated_at.

Example:

"id>123"

searchCondition
enum<string>
default:and

string - optional - Logical operator used to combine multiple search conditions. Defaults to and (all conditions must match). Set to or for any-match behavior.

Available options:
and,
or
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. Defaults to 25. Maximum is 200 when expand is present.

Example:

"5"

sort
string

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

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.

Response

Collection

items
object[]
_meta
object