Skip to main content

This page is also available as plain markdown · OpenAPI spec

List registrations

GET 
/registrations

List registrations

Request​

Query Parameters

    checkedInstring
    Example: false
    eventIdstring
    Example: 00000000-0000-0000-0000-000000000000
    occurrenceIdstring
    Example: 00000000-0000-0000-0000-000000000000
    pageinteger
    Example: 1
    perPageinteger
    Example: 1
    querystring
    Example: A-12
    sortstring
    Example: checkedInAt
    statusstring
    **Possible values:** [`active`, `canceled`, `refunded`, `partially_refunded`, `refund_pending`, `transferred`, `transfer_pending`]
    Lifecycle status to filter by. An unrecognized value returns 422.
    Example: canceled
    ticketIdstring
    Example: 00000000-0000-0000-0000-000000000000

200

Filters by event and check-in status
dataobject[]required
objectstring
idstring
statusstring
checkedInAtstringnullable
attendeeobject
firstNamestringrequired
lastNamestringrequired
emailstringrequired
seatstringnullable
relatedRegistrationIdsstring[]
eventIdstring
occurrenceIdstringnullable
ticketIdstringnullable
orderIdstringnullable
createdAtstring
updatedAtstring
objectstringrequired
pageintegerrequired
totalPagesintegerrequired
perPageintegerrequired
totalCountintegerrequired
hasNextPagebooleanrequired
metaobjectrequired
requestIdstringrequired
Example: returns_the_owner's_registrations
{
  "data": [
    {
      "object": "registration",
      "id": "94e82c2e-3cef-40ca-959d-dca55f60dee0",
      "status": "refunded",
      "checkedInAt": null,
      "attendee": {
        "firstName": "Jane",
        "lastName": "Customer",
        "email": "jane-customer@example.com"
      },
      "seat": null,
      "relatedRegistrationIds": [],
      "eventId": "ad21b3a1-2676-493e-9a3e-db57820a65fb",
      "occurrenceId": "67be87a3-9d6c-41d4-b28c-d19553ec02b2",
      "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
      "orderId": "T572027702",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    },
    {
      "object": "registration",
      "id": "d0a99332-0985-4033-83e9-97f869311035",
      "status": "active",
      "checkedInAt": null,
      "attendee": {
        "firstName": "Bob",
        "lastName": "Customer",
        "email": "bob@example.com"
      },
      "seat": null,
      "relatedRegistrationIds": [],
      "eventId": "3782416a-630b-4116-8a7d-87583f90f2f4",
      "occurrenceId": "3568757f-0a3a-4fe9-bb69-f6f6771fb3fd",
      "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
      "orderId": "T354828371",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    },
    {
      "object": "registration",
      "id": "2e377d43-1cac-493b-aee2-0b2e6a61ca2f",
      "status": "active",
      "checkedInAt": null,
      "attendee": {
        "firstName": "Alice",
        "lastName": "Patron",
        "email": "alice@example.com"
      },
      "seat": null,
      "relatedRegistrationIds": [
        "b3a7bb0f-bfce-4229-9247-425bf0762179"
      ],
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "occurrenceId": "4b34a47d-6204-4454-982e-79c0c0533646",
      "ticketId": "8e10b457-7022-4396-99f0-e9e2198ca977",
      "orderId": "T339434021",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    },
    {
      "object": "registration",
      "id": "b3a7bb0f-bfce-4229-9247-425bf0762179",
      "status": "active",
      "checkedInAt": "2025-06-11T18:30:00Z",
      "attendee": {
        "firstName": "Alice",
        "lastName": "Patron",
        "email": "alice@example.com"
      },
      "seat": null,
      "relatedRegistrationIds": [
        "2e377d43-1cac-493b-aee2-0b2e6a61ca2f"
      ],
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
      "ticketId": "8e10b457-7022-4396-99f0-e9e2198ca977",
      "orderId": "T339434021",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    },
    {
      "object": "registration",
      "id": "2364b182-3633-44f6-b10b-58076dcb3dd3",
      "status": "transfer_pending",
      "checkedInAt": null,
      "attendee": {
        "firstName": "Tessa",
        "lastName": "Transfer",
        "email": "tessa@example.com"
      },
      "seat": null,
      "relatedRegistrationIds": [],
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "occurrenceId": "4b34a47d-6204-4454-982e-79c0c0533646",
      "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
      "orderId": "T339434021",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    },
    {
      "object": "registration",
      "id": "523b9882-1c24-46fa-9b19-a39fee2c5d00",
      "status": "canceled",
      "checkedInAt": null,
      "attendee": {
        "firstName": "Walkin",
        "lastName": "Guest",
        "email": "walkin@example.com"
      },
      "seat": null,
      "relatedRegistrationIds": [],
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
      "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
      "orderId": "T339434021",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    },
    {
      "object": "registration",
      "id": "acfa16ec-1a09-4d67-85f6-b7db0afb4759",
      "status": "active",
      "checkedInAt": "2025-06-11T19:05:00Z",
      "attendee": {
        "firstName": "Alice",
        "lastName": "Patron",
        "email": "alice@example.com"
      },
      "seat": "A-12",
      "relatedRegistrationIds": [],
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
      "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
      "orderId": "T339434021",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 7,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: filters_by_event_and_check-in_status
{
  "data": [
    {
      "object": "registration",
      "id": "b3a7bb0f-bfce-4229-9247-425bf0762179",
      "status": "active",
      "checkedInAt": "2025-06-11T18:30:00Z",
      "attendee": {
        "firstName": "Alice",
        "lastName": "Patron",
        "email": "alice@example.com"
      },
      "seat": null,
      "relatedRegistrationIds": [
        "2e377d43-1cac-493b-aee2-0b2e6a61ca2f"
      ],
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
      "ticketId": "8e10b457-7022-4396-99f0-e9e2198ca977",
      "orderId": "T339434021",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    },
    {
      "object": "registration",
      "id": "acfa16ec-1a09-4d67-85f6-b7db0afb4759",
      "status": "active",
      "checkedInAt": "2025-06-11T19:05:00Z",
      "attendee": {
        "firstName": "Alice",
        "lastName": "Patron",
        "email": "alice@example.com"
      },
      "seat": "A-12",
      "relatedRegistrationIds": [],
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
      "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
      "orderId": "T339434021",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 2,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

403

When oauth token lacks registrations read scope returns 403 when oauth token lacks registrations read scope
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_403_when_oauth_token_lacks_registrations_read_scope
{
  "object": "error",
  "status": 403,
  "message": "Insufficient scope. Required: registrations_read",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

422

Returns 422 for an unrecognized status value
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
fieldstring
messagestring
metaobjectrequired
requestIdstringrequired
Example: returns_422_for_an_unrecognized_status_value
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "field": "status",
      "message": "must be one of: active, canceled, refunded, partially_refunded, refund_pending, transferred, transfer_pending"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}