This topic provides documentation for event registration Data Transfer Objects (DTOs.)

The V3 API uses a tiered structure, starting with the highest-level container (PaginatedRegistrations) down to the smallest detail (SimpleFieldDto)

DetailedRegistrationDto

The comprehensive object returned when retrieving details for a single registration (/registrations/{registration_id}).

registration_id

The unique ID used to identify an event registration.

  • Type: string

  • Example: 4g1ceb43-f858-432e-b287-30a6d20d1250

contact_id

The unique ID used to identify a contact.

  • Type: string

  • Example: 84afe95a-5866-11ec-8019-fa163e56c9b0

registration_date

The event registration date, in ISO format.

  • Type: string

  • Format: date-time

  • Example: 2025-11-20T16:13:02.072Z

registration_status

Provides the current registration status. Values: REGISTERED, PENDING, CANCELED, EXPIRED, IN_PROGRESS, FAILED.

  • Type: string

  • Example: REGISTERED

checkedIn_tickets

The total number of tickets assigned to a given registration_id that have been checked in.

  • Type: integer

  • Format: int32

  • Example: 0

eligible_checkin_tickets

The total number of tickets eligible for checkin.

  • Type: integer

  • Format: int32

  • Example: 1

checkin_status

Provides the status of eligible checkin tickets.

  • Type: string

  • Example: NOT_CHECKED_IN

display_physical_tickets

Determines if the physical tickets should display or not display.

  • Type: boolean

  • Example: True

contact

An array of contact details associated with the registration.

  • Type: array of SimpleFieldDto

tickets

Details for each ticket associated with the registration.

  • Type: array of RegistrationTicketDto

order_summary

Summary of the financial order details.

  • Type: OrderDetailsDto

RegistrantInformationLiteDto

The light-weight object used to represent a single registration within a paginated list (/registrations).

registration_id

The ID that uniquely identifies a registration.

  • Type: string

  • Example: 3f1ceb43-f858-432e-b287-30a6d20d1250

first_name

The first name of the person that registered for the event.

  • Type: string

  • Example: sarah

last_name

The last name of the person that registered for the event.

  • Type: string

  • Example: lang

email_address

The email address associated with the registered event user.

  • Type: string

  • Example: sarah_lang@mymail.com

registration_time

The time of event registration, in ISO format.

  • Type: string

  • Format: date-time

  • Example: 2025-11-20T16:13:02.072Z

registration_status

The status of a registration. Values: PENDING, REGISTERED, CANCELED, EXPIRED, IN_PROGRESS, FAILED.

  • Type: string

  • Example: REGISTERED

payment_status

The current payment status for a registration.

  • Type: string

  • Example: PAID

tickets

Total number of tickets associated with a registration.

  • Type: integer

  • Format: int32

  • Example: 5

total

The total amount paid for a registration.

  • Type: decimal

  • Example: 100.00

checkedIn_tickets

The total number of tickets processed to check in for the event.

  • Type: integer

  • Format: int32

  • Example: 1

eligible_checkin_tickets

The current checkin status.

  • Type: integer

  • Format: int32

  • Example: 2

checkin_status

The status of the check-in. Values: CHECKED_IN, NOT_CHECKED_IN, PARTIALLY_CHECKED.

  • Type: string

  • Example: CHECKED_IN

new_contact

Set to true to indicate that the contact is new.

  • Type: boolean

  • Example: true

track_key

System generated string used to track a registration.

  • Type: string

  • Example: wfhmkz

PaginatedRegistrations

The wrapper object for the list endpoint’s response, providing the list of records and pagination links/cursors.

records

The array of registrations for the current page.

  • Type: array of RegistrantInformationLiteDto

total_records

The total number of records found across all pages.

  • Type: integer

  • Format: int32

  • Example: 563

next_cursor

Cursor value to request the next page of results.

Type: string

Example: cTk9xLmmr06S55wJGfQ73hs9_yTfSYtFRlimimQhjUj

prev_cursor

Cursor value to request the previous page of results.

  • Type: string

  • Example: bSzsyWkkq95R44vIFEpY62gr8_xSeRXsEQkhnhltPgiT

_links

Contains href objects for pagination links (next, prev, self).

  • Type: Links

OrderDetailsDto

Provides a summary of the order and payment information for a registration.

number

The system assigned string value used to identify the event order.

  • Type: string

  • Example: ZWbsLNGrHT

payment_method

The payment method used (STRIPE, PAYPAL).

  • Type: string

  • Example: STRIPE

payment_status

The payment status. Values: PENDING, PAID, REFUNDED, CANCELLED, FAILED, CHARGED_BACK, UNKNOWN.

  • Type: string

  • Example: PENDING

payment_time

The date and time the payment was made, in ISO format.

  • Type: string

  • Example: 2025-08-29T14:29:57.712Z

payment_transaction_id

The unique ID used to identify a payment transaction.

  • Type: string

  • Example: 0bbfdf32-0609-4467-ad19-514130f5beaf

title

The title for the order (often the event name).

  • Type: string

  • Example: Holiday Festival of Lights

tickets_text

Text that describes the event and ticket information.

  • Type: string

  • Example: Your tickets for access…

The URL used to access purchased tickets.

  • Type: string

  • Example: https://lp.constantcontactpages.com/…

details

Array of details for items in the order.

  • Type: array of LineItemDetailsDto

RegistrationTicketDto

Details for a single ticket within a registration’s tickets array.

order_ticket_key

The system generated number used to identify a ticket order.

  • Type: string

  • Example: a1b2c3

ticket_name

The name used to identify the ticket.

  • Type: string

  • Example: General Admission

price

The price for a ticket.

  • Type: number

  • Example: 25.00

editable

Set to true to allow registrations to be modified.

  • Type: boolean

  • Example: false

checked_in_time

The event check-in time date, in ISO format (if checked in).

  • Type: string

  • Format: date-time

  • Example: 2025-11-20T16:13:02.072Z

fields

Additional fields associated with this specific ticket.

  • Type: array of SimpleFieldDto

SimpleFieldDto

A generic object used to represent various contact and ticket fields.

field_name

The formatted name used to identify a field.

  • Type: string

  • Example: CONTACT_EMAIL_ADDRESS

field_label

The human-readable label used to identify a field.

  • Type: string

  • Example: Email Address

label_key

The label key used to identify a contact’s registration details.

  • Type: string

  • Example: registration.field.label.contact_email_address

field_type

Identifies the type of field (e.g., TEXT_AREA, DATE, SINGLE_SELECT).

  • Type: string

  • Example: TEXT

display_order

If specified, determines the order in which to return the field’s details.

  • Type: integer

  • Format: int32

  • Example: 1

LineItemDetailsDto

Details for a single item (e.g., ticket, donation, fee) within an order summary.

name

The name of the line item.

  • Type: string

  • Example: General Admission

line_item_type

Type of line item. Values: TICKET, DONATION, ITEM, DISC_TICKET, DISC_ORDER, PROMO_CODE, PLAT_FEE.

  • Type: string

  • Example: TICKET

amount

The formatted amount of the line item.

  • Type: string

  • Example: $25.00

amount_unformatted

The unformatted (numeric) amount of the line item.

Type: number

Example: 25.00

An object containing navigational links, typically used in paginated responses.

next

Link to the next page of results.

  • Type: Href

prev

Link to the previous page of results.

  • Type: Href

self

Link to the current page of results.

  • Type: Href

Href

A simple object defining a single link URL.

href

The URL of the resource.

  • Type: string
Tags: events