API reference

Six endpoints, all under /v1/integrations/events and all authenticated with your key. New here? Start with Getting started.

List events

GET/v1/integrations/events

Scope: checkin:read

Only events explicitly granted to your integration.

Returns

An object containing items.

List events: response
Field	Type	Description
`items`array of Events	array of Events	Granted events, ordered by start time and ID.

Example

Request

curl -X GET "https://api.events.abundance.institute/v1/integrations/events" \
  -H "Authorization: Bearer $API_KEY"

Response 200

{
  "items": [
    {
      "id": "cm2k8v3qz0001evt7jx4n2p9a",
      "slug": "sample-summit-2027",
      "name": "Sample Summit 2027",
      "timezone": "America/New_York",
      "startsAt": "2027-01-20T21:00:00.000Z",
      "endsAt": "2027-01-21T22:00:00.000Z",
      "venueName": "Main Hall",
      "city": "Washington, DC",
      "subEvents": [],
      "tickets": [
        {
          "id": "cm2k8w0de0002tkt6fh3n8r1s",
          "name": "General",
          "kind": "attendee",
          "isVip": false,
          "subEventIds": [],
          "walkIns": true
        }
      ],
      "scopes": [
        "checkin:read",
        "checkin:write"
      ]
    }
  ]
}

Get event data

GET/v1/integrations/events/{eventId}

Scope: Any integration scope

Event details, dates, time zone, tickets and sub-events.

Returns

An Event object.

Get event data: response
Field	Type	Description
`id`string	string	The event ID. Every path includes it.
`slug`string	string	The short name used in our URLs.
`name`string	string	The event name.
`timezone`string	string	IANA time zone, like `America/New_York`. Show times in it.
`startsAt`timestamp	timestamp	When the event starts.
`endsAt`timestamp	timestamp	When the event ends.
`venueName`string or null	string or null	The venue.
`city`string or null	string or null	The city.
`subEvents[]`array	array	Parts of the event with their own door, like a dinner. A check-in names one of these, or `null` for the main door.
`.id`string	string	The sub-event ID.
`.name`string	string	Its name.
`.startsAt`timestamp	timestamp	When it starts.
`.endsAt`timestamp	timestamp	When it ends.
`tickets[]`array	array	The event’s ticket types.
`.id`string	string	The ticket type ID.
`.name`string	string	Its name, like `General`.
`.kind`enum	enum	One of `attendee`, `speaker`, `sponsor`, `vip`, `staff` or `media`.
`.isVip`boolean	boolean	Whether holders are VIPs.
`.subEventIds`array of strings	array of strings	Sub-events this ticket gets into.
`.walkIns`boolean	boolean	Legacy availability flag. Walk-in registration is outside this vendor contract.
`scopes`array of strings	array of strings	What your key may do.

Example

Request

curl -X GET "https://api.events.abundance.institute/v1/integrations/events/cm2k8v3qz0001evt7jx4n2p9a" \
  -H "Authorization: Bearer $API_KEY"

Response 200

{
  "id": "cm2k8v3qz0001evt7jx4n2p9a",
  "slug": "sample-summit-2027",
  "name": "Sample Summit 2027",
  "timezone": "America/New_York",
  "startsAt": "2027-01-20T21:00:00.000Z",
  "endsAt": "2027-01-21T22:00:00.000Z",
  "venueName": "Main Hall",
  "city": "Washington, DC",
  "subEvents": [],
  "tickets": [
    {
      "id": "cm2k8w0de0002tkt6fh3n8r1s",
      "name": "General",
      "kind": "attendee",
      "isVip": false,
      "subEventIds": [],
      "walkIns": true
    }
  ],
  "scopes": [
    "checkin:read",
    "checkin:write"
  ]
}

List registrants

GET/v1/integrations/events/{eventId}/registrants

Scope: checkin:read

Paginated registrations, including non-confirmed statuses so the desk can explain refusals.

Unfinished payment registrations are excluded.
Keep the same event, key and limit on subsequent pages. Cursors expire after 24 hours.
This is a bounded traversal, not a frozen snapshot. Queue webhooks before the import, then apply queued changes by registrationId and version.

Query

List registrants: query parameters
Field	Type	Description
`limit`integer	integer	Default 100; range 1–500.
`cursor`string	string	Opaque nextCursor from the previous page. Omit on the first request.

Returns

An object containing items and nextCursor. Stop when nextCursor is null.

List registrants: response
Field	Type	Description
`items`array of Registrants	array of Registrants	Registrants in stable creation order.
`nextCursor`string or null	string or null	Next page cursor; null at the end.

Example

Request

curl -X GET "https://api.events.abundance.institute/v1/integrations/events/cm2k8v3qz0001evt7jx4n2p9a/registrants" \
  -H "Authorization: Bearer $API_KEY"

Response 200

{
  "items": [
    {
      "registrationId": "cm2k9a1bc0004reg8hd2m5k3q",
      "eventId": "cm2k8v3qz0001evt7jx4n2p9a",
      "version": 1,
      "qrPayload": "cm2k9a1bc0004reg8hd2m5k3q",
      "status": "confirmed",
      "firstName": "Maya",
      "lastName": "Chen",
      "organization": "Northwind Energy",
      "title": "Head of Partnerships",
      "kind": "attendee",
      "registrantTypeId": "attendee",
      "ribbonLabel": "ATTENDEE",
      "isVip": false,
      "ticketTypeId": "cm2k8w0de0002tkt6fh3n8r1s",
      "ticketName": "General",
      "sponsor": null,
      "table": null,
      "accessSubEventIds": [],
      "badgePrintedAt": null,
      "checkIns": [],
      "updatedAt": "2027-01-20T20:58:12.000Z"
    }
  ],
  "nextCursor": null
}

Get individual registrant

GET/v1/integrations/events/{eventId}/registrants/{registrationId}

Scope: checkin:read

Fetch the current public registration by its CUID.

Unknown, deleted, unfinished-payment or wrong-event registrations return 404.

Returns

A Registrant object.

Get individual registrant: response
Field	Type	Description
`registrationId`string	string	The person’s ID at this event. Use it to match and update your records.
`qrPayload`string	string	Plain registration ID. Print the same value as the badge QR. A transfer retires this registration and issues a replacement ID.
`status`enum	enum	One of `confirmed`, `pending_approval`, `waitlisted`, `cancelled` or `declined`. Only `confirmed` gets in.
`firstName`string	string	Empty for a guest seat nobody has named yet.
`lastName`string	string	For an unnamed guest seat, a label like `Guest of Northwind Energy`.
`organization`string or null	string or null	Company or organization.
`title`string or null	string or null	Job title.
`kind`enum	enum	One of `attendee`, `speaker`, `sponsor`, `vip`, `staff` or `media`. A VIP attendee is `vip`.
`ribbonLabel`string or null	string or null	Text for a badge ribbon, like `SPEAKER`.
`isVip`boolean	boolean	Whether the person is a VIP.
`ticketTypeId`string	string	Their ticket type.
`ticketName`string	string	The ticket type’s name.
`sponsor`string or null	string or null	The sponsor’s name, when the person is with one.
`table`string or null	string or null	Their seat from the seating plan, like `Table 12`.
`accessSubEventIds`array of strings	array of strings	Sub-events this person may enter.
`badgePrintedAt`timestamp or null	timestamp or null	The latest badge print anyone reported.
`checkIns[]`array	array	Check-ins that weren’t undone.
`.id`string	string	The check-in ID. Use it to undo.
`.subEventId`string or null	string or null	`null` for the main door.
`.sessionId`string or null	string or null	Set when our staff checked the person into a session.
`.at`timestamp	timestamp	When it happened.
`eventId`string	string	The event this registration belongs to.
`version`integer	integer	Monotonically increasing version. Ignore older or equal versions, including webhook retries.
`registrantTypeId`enum	enum	Identifier from the registrant types endpoint; separate from ticketTypeId.
`.location`string or null	string or null	Location label supplied when scanning in.
`updatedAt`timestamp	timestamp	The last change to this record.

Example

Request

curl -X GET "https://api.events.abundance.institute/v1/integrations/events/cm2k8v3qz0001evt7jx4n2p9a/registrants/cm2k9a1bc0004reg8hd2m5k3q" \
  -H "Authorization: Bearer $API_KEY"

Response 200

{
  "registrationId": "cm2k9a1bc0004reg8hd2m5k3q",
  "eventId": "cm2k8v3qz0001evt7jx4n2p9a",
  "version": 1,
  "qrPayload": "cm2k9a1bc0004reg8hd2m5k3q",
  "status": "confirmed",
  "firstName": "Maya",
  "lastName": "Chen",
  "organization": "Northwind Energy",
  "title": "Head of Partnerships",
  "kind": "attendee",
  "registrantTypeId": "attendee",
  "ribbonLabel": "ATTENDEE",
  "isVip": false,
  "ticketTypeId": "cm2k8w0de0002tkt6fh3n8r1s",
  "ticketName": "General",
  "sponsor": null,
  "table": null,
  "accessSubEventIds": [],
  "badgePrintedAt": null,
  "checkIns": [],
  "updatedAt": "2027-01-20T20:58:12.000Z"
}

Record scan-in

PATCH/v1/integrations/events/{eventId}/registrants/{registrationId}/check-in

Scope: checkin:write

Record arrival at the event entrance. The registration ID is in the URL; time and location are in the JSON body.

Only confirmed registrations are admitted. Repeated and concurrent scans return the first admission without changing its time or location.
Location is a descriptive desk/door label. It does not select a sub-event.
For offline devices, send the original scan time after reconnecting.

Request body

Record scan-in: request body
Field	Type	Description
`time`requiredtimestamp · required	timestamp	ISO 8601 scan time with Z or an explicit offset.
`location`requiredstring · required	string	Nonempty location label, maximum 100 characters.

Returns

A Check-in result. A refused admission has a null checkIn and an explanatory outcome/message.

Record scan-in: response
Field	Type	Description
`outcome`enum	enum	Admission decision; see outcomes.
`message`string	string	Display to the operator.
`checkIn`object or null	object or null	New or original check-in; null when admission is refused.
`.id`string	string	Check-in ID.
`.time`timestamp	timestamp	Original scan-in time.
`.location`string or null	string or null	Original location label.
`registrant`Registrant	Registrant	Current registration, including check-ins and version.

Example

Request

curl -X PATCH "https://api.events.abundance.institute/v1/integrations/events/cm2k8v3qz0001evt7jx4n2p9a/registrants/cm2k9a1bc0004reg8hd2m5k3q/check-in" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data @check-in.json

check-in.json

{
  "time": "2027-01-20T21:04:00.000Z",
  "location": "Registration desk 2"
}

Response 200

{
  "outcome": "checked_in",
  "message": "Checked in.",
  "checkIn": {
    "id": "cm2kb7tuv0009chk5ny3w8p2e",
    "time": "2027-01-20T21:04:00.000Z",
    "location": "Registration desk 2"
  },
  "registrant": {
    "registrationId": "cm2k9a1bc0004reg8hd2m5k3q",
    "eventId": "cm2k8v3qz0001evt7jx4n2p9a",
    "version": 2,
    "qrPayload": "cm2k9a1bc0004reg8hd2m5k3q",
    "status": "confirmed",
    "firstName": "Maya",
    "lastName": "Chen",
    "organization": "Northwind Energy",
    "title": "Head of Partnerships",
    "kind": "attendee",
    "registrantTypeId": "attendee",
    "ribbonLabel": "ATTENDEE",
    "isVip": false,
    "ticketTypeId": "cm2k8w0de0002tkt6fh3n8r1s",
    "ticketName": "General",
    "sponsor": null,
    "table": null,
    "accessSubEventIds": [],
    "badgePrintedAt": null,
    "checkIns": [
      {
        "id": "cm2kb7tuv0009chk5ny3w8p2e",
        "subEventId": null,
        "sessionId": null,
        "at": "2027-01-20T21:04:00.000Z",
        "location": "Registration desk 2"
      }
    ],
    "updatedAt": "2027-01-20T20:58:12.000Z"
  }
}

List registrant types

GET/v1/integrations/events/{eventId}/registrant-types

Scope: checkin:read

Stable identifiers and display labels. Registrants carry the identifier in registrantTypeId.

Registrant categories and ticket products are separate.

Returns

An object containing items.

List registrant types: response
Field	Type	Description
`items[]`array	array	Registrant categories.
`.id`enum	enum	One of `attendee`, `speaker`, `sponsor`, `vip`, `staff` or `media`.
`.name`string	string	Display label.

Example

Request

curl -X GET "https://api.events.abundance.institute/v1/integrations/events/cm2k8v3qz0001evt7jx4n2p9a/registrant-types" \
  -H "Authorization: Bearer $API_KEY"

Response 200

{
  "items": [
    {
      "id": "attendee",
      "name": "Attendee"
    },
    {
      "id": "speaker",
      "name": "Speaker"
    },
    {
      "id": "sponsor",
      "name": "Sponsor"
    },
    {
      "id": "vip",
      "name": "VIP"
    },
    {
      "id": "staff",
      "name": "Staff"
    },
    {
      "id": "media",
      "name": "Media"
    }
  ]
}

The Registrant object

One registration, shared by paginated reads, individual reads, check-in responses and webhook snapshots.

Registrant fields
Field	Type	Description
`registrationId`string	string	The person’s ID at this event. Use it to match and update your records.
`qrPayload`string	string	Plain registration ID. Print the same value as the badge QR. A transfer retires this registration and issues a replacement ID.
`status`enum	enum	One of `confirmed`, `pending_approval`, `waitlisted`, `cancelled` or `declined`. Only `confirmed` gets in.
`firstName`string	string	Empty for a guest seat nobody has named yet.
`lastName`string	string	For an unnamed guest seat, a label like `Guest of Northwind Energy`.
`organization`string or null	string or null	Company or organization.
`title`string or null	string or null	Job title.
`kind`enum	enum	One of `attendee`, `speaker`, `sponsor`, `vip`, `staff` or `media`. A VIP attendee is `vip`.
`ribbonLabel`string or null	string or null	Text for a badge ribbon, like `SPEAKER`.
`isVip`boolean	boolean	Whether the person is a VIP.
`ticketTypeId`string	string	Their ticket type.
`ticketName`string	string	The ticket type’s name.
`sponsor`string or null	string or null	The sponsor’s name, when the person is with one.
`table`string or null	string or null	Their seat from the seating plan, like `Table 12`.
`accessSubEventIds`array of strings	array of strings	Sub-events this person may enter.
`badgePrintedAt`timestamp or null	timestamp or null	The latest badge print anyone reported.
`checkIns[]`array	array	Check-ins that weren’t undone.
`.id`string	string	The check-in ID. Use it to undo.
`.subEventId`string or null	string or null	`null` for the main door.
`.sessionId`string or null	string or null	Set when our staff checked the person into a session.
`.at`timestamp	timestamp	When it happened.
`eventId`string	string	The event this registration belongs to.
`version`integer	integer	Monotonically increasing version. Ignore older or equal versions, including webhook retries.
`registrantTypeId`enum	enum	Identifier from the registrant types endpoint; separate from ticketTypeId.
`.location`string or null	string or null	Location label supplied when scanning in.
`updatedAt`timestamp	timestamp	The last change to this record.

Registrant

{
  "registrationId": "cm2k9a1bc0004reg8hd2m5k3q",
  "eventId": "cm2k8v3qz0001evt7jx4n2p9a",
  "version": 1,
  "qrPayload": "cm2k9a1bc0004reg8hd2m5k3q",
  "status": "confirmed",
  "firstName": "Maya",
  "lastName": "Chen",
  "organization": "Northwind Energy",
  "title": "Head of Partnerships",
  "kind": "attendee",
  "registrantTypeId": "attendee",
  "ribbonLabel": "ATTENDEE",
  "isVip": false,
  "ticketTypeId": "cm2k8w0de0002tkt6fh3n8r1s",
  "ticketName": "General",
  "sponsor": null,
  "table": null,
  "accessSubEventIds": [],
  "badgePrintedAt": null,
  "checkIns": [],
  "updatedAt": "2027-01-20T20:58:12.000Z"
}

The Check-in result

What happened to the scan-in. Repeated scans return the original check-in time and location.

Check-in result fields
Field	Type	Description
`outcome`enum	enum	Admission decision; see outcomes.
`message`string	string	Display to the operator.
`checkIn`object or null	object or null	New or original check-in; null when admission is refused.
`.id`string	string	Check-in ID.
`.time`timestamp	timestamp	Original scan-in time.
`.location`string or null	string or null	Original location label.
`registrant`Registrant	Registrant	Current registration, including check-ins and version.

Registration webhook

Outbound POST to your configured HTTPS receiver. See signature verification, retries and import synchronization.

Registration webhook fields
Field	Type	Description
`id`string	string	Unique event/delivery ID. Stable across retries and manual replay.
`type`enum	enum	`registration.created`, `registration.modified` or `registration.deleted`.
`eventId`string	string	Granted event ID.
`registrationId`string	string	Affected registration ID.
`version`integer	integer	Apply only when greater than the version stored for this registration.
`occurredAt`timestamp	timestamp	When this change was captured.
`data`Registrant or null	Registrant or null	Immutable public snapshot; null for a deletion tombstone.

Webhook

{
  "id": "a6ae4401-3c86-4c37-9a46-a176c03a563b",
  "type": "registration.created",
  "eventId": "cm2k8v3qz0001evt7jx4n2p9a",
  "registrationId": "cm2k9a1bc0004reg8hd2m5k3q",
  "version": 1,
  "occurredAt": "2027-01-20T20:58:12.000Z",
  "data": {
    "registrationId": "cm2k9a1bc0004reg8hd2m5k3q",
    "eventId": "cm2k8v3qz0001evt7jx4n2p9a",
    "version": 1,
    "qrPayload": "cm2k9a1bc0004reg8hd2m5k3q",
    "status": "confirmed",
    "firstName": "Maya",
    "lastName": "Chen",
    "organization": "Northwind Energy",
    "title": "Head of Partnerships",
    "kind": "attendee",
    "registrantTypeId": "attendee",
    "ribbonLabel": "ATTENDEE",
    "isVip": false,
    "ticketTypeId": "cm2k8w0de0002tkt6fh3n8r1s",
    "ticketName": "General",
    "sponsor": null,
    "table": null,
    "accessSubEventIds": [],
    "badgePrintedAt": null,
    "checkIns": [],
    "updatedAt": "2027-01-20T20:58:12.000Z"
  }
}

Check-in outcomes

The same rules our own staff app uses. Show the message as it comes; the examples below are typical.

Outcomes
Outcome	Means	Example message
`checked_in`	Admitted; the scan-in was recorded.	Checked in.
`already_checked_in`	Previously admitted. Original time and location are returned unchanged.	Already checked in at 9:14 AM.
`not_confirmed`	Pending approval, waitlisted, cancelled or declined. Do not admit.	Needs approval. Send to the help desk.
`not_allowed`	Not allowed into the requested admission area.	Not included in this ticket.
`not_found`	No registration on the selected event roster.	Not on the guest list. Send to the help desk.