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).
- NA URL https://io.cvent.com/onsite/v1
- EU URL https://io-eur.cvent.com/onsite/v1 The following example uses the north American endpoint. Swap the URL as needed if your account is European.
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
| Parameter | Value | Parameter Type | Data Type |
|---|---|---|---|
| Authorization | (required) | header | string |
| eventId | (required) | path | string |
| exhibitorId | (required) | path | string |
| referenceId | (required) | path | string |
| includeCustomFields | true (default) | query | boolean |
| pt-access-code | N/A (default) | header | string |
| deviceId | custom | header | string |
Response Messages
| HTTP Status Code | Value |
|---|---|
| 200 | Success |
| 401 | Unauthorized access |
| 404 | Objects not found |
| 500 | Failed 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”
}Consent
If attendees didn’t grant consent to be scanned onsite, your response will show that the attendee cannot be found.
Last updated on