In This Article
Filter and Sort
Select endpoints allow sorting results by field. Use field:asc
to sort results in ascending order, and field:desc
to sort in descending order.
For example, to sort events by start date in ascending order, and then by modification date in descending order:
Copy
1?sort=start:asc,modified:desc
or
Copy
1"sort": "start:asc,modified:desc"
Refer to the following tables to check which fields support sorting.
List & Query Events
Field | Description | Query Filter Operators | Sorting | Facets |
---|---|---|---|---|
created | Creation date | Allowed | ||
modified | Modification date | Allowed | ||
start | Start date | Allowed | ||
end | End date | Allowed | ||
title | $eq,$ne,$lt,$lte,$gt,$gte,$hasSome,$contains,$urlized | Allowed | ||
slug | URL slug | $eq,$ne,$lt,$lte,$gt,$gte,$hasSome,$contains,$urlized | Allowed | |
status | $eq,$ne,$hasSome,$contains | Allowed | ||
eventId | $eq,$ne,$hasSome | |||
userId | $eq,$ne,$hasSome |
List & Query RSVPs
Field | Description | Query Filter Operators | Sorting | Facets |
---|---|---|---|---|
created | Creation date | Allowed | ||
modified | Modification date | Allowed | ||
name | Guest name | Allowed | ||
score | Search phrase relevance | Allowed | ||
Guest email | Allowed | |||
totalGuests | Guest count | Allowed | ||
status | Guest response | $eq,$ne,$hasSome | Allowed | Allowed |
rsvpId | $eq,$ne,$hasSome | |||
eventId | $eq,$ne,$hasSome |
List & Query Available Tickets
Field | Description | Query Filter Operators | Sorting |
---|---|---|---|
created | Creation date | Allowed | |
price | Allowed | ||
orderIndex | Allowed | ||
ticketDefinitionId | $eq,$ne,$hasSome,$in | ||
eventId | $eq,$ne,$hasSome,$in | ||
name | $eq,$ne,$lt,$lte,$gt,$gte,$hasSome,$in,$contains,$urlized | Allowed |
List Tickets
Field | Description | Sorting | Facets |
---|---|---|---|
ticketNumber | Allowed | ||
orderStatus | Order status | Allowed | |
price | Ticket price | Allowed | |
orderFullName | Buyer name | Allowed | |
guestFullName | Guest name | Allowed | |
score | Search phrase relevance | Allowed | |
free | Allowed | ||
archived | Allowed | ||
checkedIn | Allowed |
List Ticket Definitions
Field | Description | Sorting |
---|---|---|
created | Creation date | Allowed |
modified | Modification date | Allowed |
orderIndex | Allowed |
Query Ticket Definitions
Field | Description | Query Filter Operators | Sorting |
---|---|---|---|
created | Creation date | Allowed | |
price | Allowed | ||
orderIndex | Allowed | ||
ticketDefinitionId | $eq,$ne,$hasSome,$in | ||
eventId | $eq,$ne,$hasSome,$in | ||
name | $eq,$ne,$lt,$lte,$gt,$gte,$hasSome,$in,$contains,$urlized | Allowed |
List Orders
Field | Description | Sorting | Facets |
---|---|---|---|
created | Creation date | Allowed | |
name | Guest name | Allowed | |
score | Search phrase relevance | Allowed | |
orderNumber | Allowed | ||
status | Order status | Allowed | |
archived | Allowed | ||
fullyCheckedIn | Allowed |
Query Policies
Field | Query Filter Operators |
---|---|
policyId | $eq,$ne,$hasSome,$contains |
eventId | $eq,$hasSome |
Was this helpful?
Yes
No