Skip to main content

List events

GET /events

Requires the events:read permission. Returns records belonging to the authenticated organisation, including unpublished or inactive records unless filtered.

Authorization​

X-API-Key required

Parameters​

NameLocationTypeRequiredDefaultLimitsDescription
pagequeryintegerNo1min 1, max 1000000Page number
limitqueryintegerNo10min 1, max 100Results per page
statusquerydraft, published, unlisted, cancelledNoExact stored event status
audiencequerymembers, publicNoEvent audience
slugquerystringNomin length 1, max length 200Exact event slug
startsAfterquerystring (date-time)NoInclusive lower bound on startsAt
startsBeforequerystring (date-time)NoInclusive upper bound on startsAt
updatedSincequerystring (date-time)NoInclusive ISO 8601 lower bound on updatedAt
createdAfterquerystring (date-time)NoInclusive ISO 8601 lower bound on createdAt
createdBeforequerystring (date-time)NoInclusive ISO 8601 upper bound on createdAt
searchquerystringNomax length 200Case-insensitive literal search over name, slug

Data and reconciliation​

Amounts use major currency units (for example, GBP 25.50 is returned as 25.5). Currency codes are lowercase. Relationship fields contain RemyPass record IDs; use the matching get endpoint to fetch related records. Optional relationships and dates may be absent or null. Checkout tokens, internal metadata, payment-provider credentials and worker leases are excluded.

List responses sort by updatedAt ascending, then _id ascending. Keep the same filters while paging. updatedSince is inclusive and requires a timezone. See incremental sync for overlap, deduplication and deletion handling.

Request Examples​

curl -X GET "https://api.remypass.com/api/v1/public/events" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Responses​

StatusDescription
200Success
400Bad request. The top-level message explains what is invalid and, where applicable, the errors array contains structured field details.
401Missing or invalid API key.
403The caller is not allowed to access this resource.
429Rate limit exceeded.
500Server error.

200 Response Example​

{
"success": true,
"message": "Success",
"data": [
{
"_id": "507f1f77bcf86cd799439011",
"createdAt": "2026-10-06T12:00:00.000Z",
"updatedAt": "2026-10-06T12:00:00.000Z",
"name": "Example",
"slug": "example",
"description": "",
"imageUrl": "https://example.com/webhook",
"startsAt": "2026-10-06T12:00:00.000Z",
"endsAt": "2026-10-06T12:00:00.000Z",
"timezone": "example",
"location": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"region": "example",
"postalCode": "example",
"country": "example",
"what3words": "example"
},
"ticketPrice": {
"amount": 0,
"currency": "gbp"
},
"ticketPricingMode": "single",
"ticketPricingOptions": [
{
"id": "example",
"label": "example",
"description": "example",
"_id": "507f1f77bcf86cd799439011",
"price": {}
}
],
"ticketPolicy": "free_required",
"issueDigitalPass": true,
"ticketCapacity": 1,
"registrationEndsAt": "2026-10-06T12:00:00.000Z",
"audience": "members",
"status": "draft"
}
],
"pagination": {
"currentPage": 1,
"totalPages": 5,
"totalItems": 47,
"itemsPerPage": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}

Response Fields​

FieldTypeDescriptionAttributes
successboolean
messagestring
dataarray of object
Show child attributes
  • _id: string — RemyPass record _id
  • createdAt: string (date-time) — created At
  • updatedAt: string (date-time) — updated At
  • name: string — name
  • slug: string — slug
  • description: string — description
  • imageUrl: string — image Url
  • startsAt: string (date-time) — starts At
  • endsAt: string (date-time) — ends At
  • timezone: string — timezone
  • location: object
    Show child attributes
    • addressLine1: string — address Line1
    • addressLine2: string — address Line2
    • city: string — city
    • region: string — region
    • postalCode: string — postal Code
    • country: string — country
    • what3words: string — what3words
  • ticketPrice: object
    Show child attributes
    • amount: number — Money in major currency units
    • currency: string — currency
  • ticketPricingMode: single, multiple — ticket Pricing Mode
  • ticketPricingOptions: array of object — ticket Pricing Options
    Show child attributes
    • id: string — id
    • label: string — label
    • description: string — description
    • _id: string — Related RemyPass record _id
    • price: object
      Show child attributes
      • amount: number — Money in major currency units
      • currency: string — currency
  • ticketPolicy: free_required, paid_required — ticket Policy
  • issueDigitalPass: boolean — issue Digital Pass
  • ticketCapacity: number — ticket Capacity
  • registrationEndsAt: string (date-time) — registration Ends At
  • audience: members, public — audience
  • status: draft, published, unlisted, cancelled — status
paginationobject
Show child attributes
  • currentPage: integer
  • totalPages: integer
  • totalItems: integer
  • itemsPerPage: integer
  • hasNextPage: boolean
  • hasPrevPage: boolean