Attendees

If your organizer account has the "Registration forms" feature activated, and you have set up a form for any of your events, you can use the API methods described on this page to access the information your attendees filled in.

Note

Before calling any of the methods on this page, you must obtain a valid authorization token. To learn about obtaining an authorization token, please read the Authentication section.

List attendees

This method returns a paginated list of the information your attendees entered into the form you set up for a particular event.

HTTP request

POST https://l.oveit.com/api/events/attendees

Request parameters

Parameter Description
token A valid access token, obtained in the Authentication step.
id The unique event ID. Please see the Event data page for information on obtaining event IDs.
since (Optional) A cursor for use in pagination. since is the ticket code that defines your place in the list. For instance, if you make a request and receive 50 attendees, ending with the attendee with the ticket code abcdef123, your subsequent call can include since=abcdef123 in order to fetch the next page of the list.

Response example

{
    "fields": [
        {
            "id": 1234,
            "name": "Name",
            "type": "text",
            "is_mandatory": true
        },
        {
            "id": 1235,
            "name": "Email",
            "type": "email",
            "is_mandatory": false
        },
        {
            "id": 1236,
            "name": "Days",
            "type": "select",
            "is_mandatory": true
        },
        {
            "id": 1237,
            "name": "Photo",
            "type": "file",
            "is_mandatory": false
        },
        {
            "id": 1238,
            "name": "Birthday",
            "type": "date",
            "is_mandatory": false
        } 
    ],
    "total": 536,
    "attendees": [
        {
            "id": 12345,
            "order_id": 1234,
            "ticket_id": 100,
            "ticket_code": "dc384cbf",
            "ticket_type": {
                "id": 438,
                "name": "Entry ticket"
            },
            "created_at": "2015-10-05T14:31:50+0300",
            "values": [
                "John Doe",
                "john@example.com",
                [
                    "Monday",
                    "Tuesday"
                ],
                {
                    "id": 1188,
                    "name": "john.jpg",
                    "mime_type": "image/jpg",
                    "size": 2097152
                },
                "1980-09-23"
            ],
            "checkins": [
                {
                    "addon_id": 5,
                    "date": "2016-08-10T11:49:18+00:00"
                },
                {
                    "addon_id": null,
                    "date": "2016-08-10T11:49:18+00:00"
                }
            ]           
        },
        {
            "id": 12346,
            "order_id": 1234,
            "ticket_id": 200,
            "ticket_code": "f129ba79",
            "ticket_type": {
                "id": 438,
                "name": "Entry ticket"
            },           
            "created_at": "2015-10-05T14:31:50+0300",
            "values": [
                "Jane Doe",
                null,
                [
                    "Tuesday",
                    "Friday",
                    "Saturday"
                ],
                null,
                "1985-08-15"
            ],
            "checkins": []
        }
    ]
}

Notes:

  • The available field types are text, email, date, select and file.
  • The attendee list will contain a maximum of 50 items per request. Please read the description of the since parameter above for more information.
  • The created_at attribute is a date formatted using the complete ISO 8601 format.
  • The size attribute of values corresponding to fields with type=file is expressed in bytes.
  • The values corresponding to fields with type=date are formatted using the ISO 8601 YYYY-MM-DD format.
  • Values for fields the attendee left blank (only possible with non-mandatory fields) are represented by null.
  • The corresponding value for a field with type=select is always an array, even when multiple selection is not enabled in the field settings.

Download a file

If any of the fields you set up for an event have type=file, you can use this method to download the files your attendees have uploaded.

HTTP request

POST https://l.oveit.com/api/attendees/download_file

Request parameters

Parameter Description
token A valid access token, obtained in the Authentication step.
event_id The unique event ID.
ticket_code The ticket code that corresponds to the attendee, obtained in the (previous step)[#list-attendees].
id The unique ID of the file you want to download, obtained in the (previous step)[#list-attendees].

Note:

To distinguish between an API error and the actual file contents we suggest you verify the Content-Type response header, which is always text/json when an error occurs and application/octet-stream when the actual file is being sent back.