Skip to main content

Querying

List endpoints support pagination and selected filters.

Pagination​

List endpoints use page and limit.

  • page defaults to 1.
  • limit defaults to 10.
  • limit must be between 1 and 100.

Pagination metadata is returned in the response:

{
  "pagination": {
    "currentPage": 1,
    "totalPages": 5,
    "totalItems": 47,
    "itemsPerPage": 10,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

Filters​

  • Members: search, status
  • Passes: status, memberId, includeVoid
  • Pass templates: search

The OpenAPI reference lists the exact filters available for each endpoint.

Filter Notes​

  • search is a text search where supported.
  • Member status supports active and inactive.
  • Pass status supports active, inactive, expired, and void.
  • includeVoid controls whether revoked passes are included in pass list results.

Examples​

GET /api/v1/public/members?search=john&status=active&page=1&limit=25
GET /api/v1/public/passes?status=active&includeVoid=false&page=1&limit=10