Retrieve Attendance Records API | EventBookings Developer Hub

Purpose

This endpoint retrieves detailed information about a specific ticket using its unique identifier (uuid). It provides ticket attributes, related product details, attendee information, and attendance history, offering insights into the ticket's status, session participation, and event data.

Scope

event.list_attendance → Attendances list permission must be granted from the application to view the ticket details.

Use Case

Event organisers or ticket managers use this endpoint to view comprehensive details about a particular ticket, including attendee information, event sessions, and attendance history, ensuring they can track ticket status and usage.

Path Parameters

Parameter	Type	Description
ticket_uuid	string	The unique identifier for the ticket to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

No request body is required for this endpoint.

Response

The response returns a comprehensive set of details about the ticket, including attributes (name, order ID, ticket ID), product details (event name, timezone, start time), and attendance records (check-in/check-out activities). This response is crucial for users to access ticket-specific data efficiently.

                JSON
              
{
  "uuid": "UUID",
  "attributes": [
    {
      "name": "NAME",
      "value": "VALUE"
    },
    {
      "name": "ORDER_ID",
      "value": "VALUE"
    },
    {
      "name": "TICKET_ID",
      "value": "VALUE"
    },
    {
      "name": "SEAT",
      "value": "NULL"
    },
    {
      "name": "CODES",
      "value": {
        "type": "TYPE",
        "value": "VALUE",
        "image": "IMAGE"
      }
    }
  ],
  "product": [
    {
      "uuid": "UUID",
      "name": "EVENT_NAME",
      "value": "VALUE"
    },
    {
      "name": "DISABLE_SCANNING",
      "value": "BOOLEAN",
      "message": "NULL"
    },
    {
      "name": "EVENT_TIMEZONE",
      "value": "TIMEZONE"
    },
    {
      "name": "EVENT_STARTS_ON",
      "value": {
        "utc": "DATE_TIME",
        "local": "DATE_TIME"
      }
    },
    {
      "name": "SELL_SESSION",
      "value": "BOOLEAN"
    },
    {
      "name": "SESSION",
      "value": "NULL"
    },
    {
      "name": "ATTENDEE_DETAILS",
      "value": {
        "uuid": "UUID",
        "attributes": [
          {
            "field_name": "FIRST_NAME",
            "field_value": "VALUE"
          },
          {
            "field_name": "LAST_NAME",
            "field_value": "VALUE"
          },
          {
            "field_name": "EMAIL",
            "field_value": "EMAIL"
          },
          {
            "field_name": "IMAGE",
            "field_value": "NULL"
          }
        ]
      }
    },
    {
      "name": "ATTENDANCE_SETTINGS",
      "value": "NULL"
    }
  ],
  "attendance": [
    {
      "uuid": "UUID",
      "created_by": "UUID",
      "device": {
        "uuid": "UUID",
        "name": "DEVICE_NAME"
      },
      "activity_on": {
        "utc": "DATE_TIME",
        "local": "DATE_TIME"
      },
      "session": "NULL",
      "type": "NULL",
      "activity": "ACTIVITY"
    }
  ]
}

Attribute	Type	Description
uuid	String (UUID)	Unique identifier for the event or entity.
attributes	Array of Objects	List of attributes related to the event, such as name, order ID, ticket ID, and seat information.
attributes.name	String	Name of the attribute.
attributes.value	String/Object/Null	Value of the attribute. Can be a string, null, or an object depending on the attribute name.
attributes.value.type	String	Type of code.
attributes.value.value	String	Code value.
attributes.value.image	String	URL or path to the image representing the code.
product	Array of Objects	Details about the products or events related to the response.
product.uuid	String (UUID)	Unique identifier for the product or event.
product.name	String	Name of the product attribute.
product.value	String/Boolean/Array/Object	Value of the product attribute. Can be a string, boolean, array, or object depending on the attribute.
product.value.utc	String (Datetime)	UTC date and time when the event starts.
product.value.local	String (Datetime)	Local date and time when the event starts.
product.value.attributes	Array of Objects	List of attendee details attributes such as first name.
product.value.attributes.field_name	String	Name of the attendee detail field.
product.value.attributes.field_value	String	Value of the attendee detail field.
attendance	Array of Objects	Details about attendance, including UUID, device information, activity, and session.
attendance.uuid	String (UUID)	Unique identifier for the attendance record.
attendance.created_by	String (UUID)	UUID of the user or entity that created the attendance record.
attendance.device	Object	Information about the device used for attendance activities.
attendance.device.uuid	String	Unique identifier for the device.
attendance.device.name	String	Name of the device.
attendance.activity_on	Object	Details of the activity timestamp in both UTC and local formats.
attendance.activity_on.utc	String (Datetime)	UTC timestamp of the activity.
attendance.activity_on.local	String (Datetime)	Local timestamp of the activity.
attendance.session	Null/Object	Represents the session related to the attendance. Null when there is no session.
attendance.type	String	Type of activity or event.
attendance.activity	String	Activity performed.

Retrieve Ticket Details: /tickets/{ticket_uuid}