Skip Main Navigation
Page Content

Attendee

Attendee

Attendee is an object representing the details of one or more people coming to the event. Each order has one attendee per ticket sold (you can think of the Attendee as representing an individual ticket for all intents and purposes).

If the event is set to collect information for only the ticket purchaser (the default), all returned attendees will have the same information, apart from the barcodes and ticket_class_id.

Attendee objects are considered private and are only available to the event owner.

Fields

  • created datetime: When the attendee was created (order placed)
  • changed datetime: When the attendee was last changed
  • ticket_class_id string: The ticket_class that the attendee registered with
  • ticket_class_name string: The name of the ticket_class at the time of registration
  • profile attendee-profile: The attendee’s basic profile information
  • addresses attendee-addresses: The attendee’s basic profile information
  • questions attendee-questions: The per-attendee custom questions (optional)
  • answers attendee-answers: The attendee’s answers to any custom questions (optional)
  • barcodes attendee-barcodes: The attendee’s entry barcode information
  • team attendee-team: The attendee’s team information (optional)
  • affiliate attendee-affiliate: The attendee’s affiliate code (optional)
  • checked_in boolean: If the attendee is checked in
  • cancelled boolean: If the attendee is cancelled
  • refunded boolean: If the attendee is refunded
  • status string: The status of the attendee (scheduled to be deprecated)
  • event_id string: The event id that this attendee is attending
  • order_id string: The order id this attendee is part of
  • guestlist_id string: The guestlist id for this attendee. If this is null it means that this is not a guest.
  • invited_by string: The guest of for the guest. If this is null it means that this is not a guest.
  • delivery_method string: The method of delivery that is to be used for the attendee. One of will_call, electronic or shipping. This can be null.

Expansions

  • event from event_id event: The event this attendee is attending
  • order from order_id order: The order this attendee is part of
  • promotional_code from promotional_code promotional_code: The promotional code applied to this attendee
  • assigned_number from assigned_number assigned_number: The bib number assigned to this attendee if one exists for a race or endurance event
  • answers attendee-answers: The attendee’s answers to any custom questions (optional)
  • survey attendee-questions: The per-attendee survey questions (optional)
  • assigned_unit attendee-assigned-unit: The attendee’s seating assignment details if reserved seating (optional)

Attendee Profile

Contains the attendee’s personal information

  • name string: The attendee’s name. Use this in preference to first_name/last_name/etc. if possible for forward compatibility with non-Western names.
  • email string: The attendee’s email address
  • first_name string: The attendee’s first name
  • last_name string: The attendee’s last name
  • prefix string: The title or honoraria used in front of the name (Mr., Mrs., etc.) (optional)
  • suffix string: The suffix at the end of the name (e.g. Jr, Sr) (optional)
  • age integer: The attendee’s age (optional)
  • job_title string: The attendee’s job title (optional)
  • company string: The attendee’s company name (optional)
  • website string: The attendee’s website address (optional)
  • blog string: The attendee’s blog address (optional)
  • gender string: The attendee’s gender (currently one of “male” or “female”) (optional)
  • birth_date date: The attendee’s birth date (optional)
  • cell_phone string: The attendee’s cell/mobile phone number, as formatted by them (optional)

Attendee Addresses

Contains the attendee’s various different addresses. All are optional.

  • home address: The attendee’s home address
  • ship address: The attendee’s shipping address
  • work address: The attendee’s work address

Attendee Questions

A list of survey question objects:

  • id string: The ID of the custom question
  • label string: The label of the custom question
  • type string: One of text, url, email, date, number, address, or dropdown
  • required bool: Whether or not an answer is required

Attendee Answers

A list of objects with answers to custom questions:

  • question_id string: The ID of the custom question

  • question string: The text of the custom question

  • type string: One of text, url, email, date, number, address, or dropdown

  • answer: Type varies based on the question type. Most types have a string answer, except for the following with object answers:
    • for address:

      {
          "address_1": "",
          "address_2": "",
          "city": "",
          "country: "",
          "postal_code": "",
          "region": ""
      }
      
    • for date:

      {
          "month": "1",
          "day": "2",
          "year": "1988"
      }
      

Attendee Barcodes

A list of objects representing the barcodes for this order (usually only one per attendee):

  • barcode string: The barcode contents.
Note that when viewed by the attendee, if the event organizer has turned off printable tickets, or if the organizer has method of delivery and the attendee method of delivery is not electronic, this field will be null in order to prevent exposing the barcode value. When viewed by the organizer with “event.orders:read” permission, the barcode will always be provided.
  • status string: One of unused, used, or refunded
  • created datetime: When the attendee barcode was created
  • changed datetime: When the attendee barcode was changed
  • is_printed boolean: True if ticket have been printed

Attendee Team

Represents team information for the attendee if the event has teams configured.

  • id string: The team’s ID
  • name string: The team’s name
  • date_joined datetime: When the attendee joined the team
  • event_id string: The event the team is part of

Attendee Assigned Unit

Contains the attendee’s seating assignment details

  • unit_id string: The seating assignment’s ID. This value can never be null.
  • description string: Detailed description for the seating assignment. This is calculated from title and strings of this seating assignment. This value can never be null.
  • location_image unit-location-image: This seat assignment’s physical location on the seatmap. This value is null or omitted if seatmap is not published for this event.
  • labels: list: List of label strings of this seating assignment. This value can never be null.
  • titles: list: List of title strings of this seating assignment. This value can never be null. Number of titles are always equal or more than number of labels. If seat locations are displayed in the grid view, api client is expected to group assigned locations by titles and use a separate grid for each unique titles.

For example:

{
    "titles": ["Area", "Row", "Seat"],
    "labels": ["100", "A", "23"]
}

{
    "titles": ["Area", "Row", "Seat"],
    "labels": ["100", "A", "24"]
}

{
    "titles": ["Table", "Chair"],
    "labels": ["VIP", "8"]
}

{
    "titles": ["Area", "Row", "Seat"],
    "labels": ["Floor"]
}

would be displayed as two grids

Area Row Seat
100 A 23
100 A 24
Floor    
Table Chair
VIP 8

Unit Location Image

Contains the seat assignment’s physical coordinate on the seatmap and the corresponding seatmap image url.

  • url string: fully qualified url of the seatmap image. Currently all seatmap images are in 660x660 .png format. This value can never be null.
  • x: float: x coordinate of this seat’s location within this seatmap measured in % from the left edge of seatmap. The value ranges from 0.0 between 100.0. This value can never be null.
  • y: float: y coordinate of this seat’s location within this seatmap measured in % from the top edge of seatmap. The value ranges from 0.0 between 100.0. This value can never be null.

“Pin” (“My seat is here”) for a given seat assignment can be displayed using this seat location image info. For a given order with multiple attendees, all seat assignments are usually placed on the same seatmap image. In case different seatmap images are used within the same order, only those locations with the identical image url should be displayed on the same image. Even when there are many assigned seats within very small part of image, we recommend placing “pin” for each seat. Alternatively, x-y coordinates can be compared to place a single pin for seats that are close together.