Description

Use this call to get a complete a list of information about the attendees you scan during the event.

Note

Attendees Object call is the only one that you can do with BadgeKit. if you have any questions about wanting to make another call, contact your account manager.

Supported Methods

You’ll use one of the following endpoints depending if your account is located in North America (NA) or Europe (EU).

GET

https://io.cvent.com/onsite/v1/events/{eventId}/exhibitors/{exhibitorId}/attendees/{referenceId}

Examples

Attendees retrieved

{

  “customFields”: [

    {

      “id”: “string”,

      “name”: “string”,

      “value”: “string”

    }

  ],

  “eventId”: “string”,

  “eventName”: “string”,

  “exhibitorId”: “string”,

  “exhibitorName”: “string”,

  “referenceId”: “string”,

  “firstName”: “string”,

  “lastName”: “string”,

  “email”: “string”,

  “company”: “string”,

  “title”: “string”,

  “workPhone”: “string”,

  “mobilePhone”: “string”,

  “homePhone”: “string”,

  “workAddress”: {

    “address1”: “string”,

    “address2”: “string”,

    “country”: “string”,

    “state”: “string”,

    “city”: “string”,

    “zip”: “string”

  },

  “homeAddress”: {

    “address1”: “string”,

    “address2”: “string”,

    “country”: “string”,

    “state”: “string”,

    “city”: “string”,

    “zip”: “string”

  },

}

Parameters

ParameterValueParameter TypeData Type
Authorization(required)headerstring
eventId(required)pathstring
exhibitorId(required)pathstring
referenceId(required)pathstring
includeCustomFieldstrue (default)queryboolean
pt-access-codeN/A (default)headerstring
deviceIdcustomheaderstring

Response Messages

HTTP Status CodeValue
200Success
401Unauthorized access
404Objects not found
500Failed to get objects

Response Content Type

application/JSON

Response Codes - Error handling

If your call is unsuccessful, you will get a response in the format shown below.

{
“message”: “string”
}

If attendees didn’t grant consent to be scanned onsite, your response will show that the attendee cannot be found.

Last updated on