Get a specific attendee
The "Get a Specific Attendee" API allows users to retrieve detailed information about a specific attendee by passing the attendee_id along with the portal_id and event_id for their Zoho Backstage event.
Header
Authorization: Zoho-OAuth token d92d4xxxxxxxxxxxxx15f52
OAuth Scope
zohobackstage.attendee.READ
Path Parameters
- portal_id (Long Integer)
The unique identifier of the portal from which you want to retrieve the attendee. For example, "portal_id": "19593237" specifies the portal with ID 19593237. - event_id (Long Integer)
The unique identifier of the event for which you want to retrieve attendee details. For example, "event_id": "2000000116588" specifies the event with ID 2000000116588. - attendee_id (Long Integer)
The unique identifier of the attendee. For example, "attendee_id": "8649000132755104" specifies the attendee with ID 8649000132755104.
Response Structure and Field Explanations
The response provides a JSON object containing the details of the specified attendee. Below are the fields included in the response, along with explanations:
- id (Long Integer)
The unique identifier for the attendee. For example, "id": "25000000121431" identifies the attendee with ID 25000000121431. - portal (Long Integer)
The unique identifier for the portal. For example, "portal": "20942323" specifies the portal with ID 20942323. - event_id (Long Integer)
The unique identifier for the event. For example, "event_id": "25000000016003" specifies the event with ID 25000000016003. - order_id (Long Integer)
The unique identifier for the order associated with the attendee. For example, "order_id": "25000000121424" identifies the order with ID 25000000121424. - ticket_id (Long Integer)
The unique identifier for the ticket. For example, "ticket_id": "250000001214242" specifies the ticket with ID 250000001214242. - ticket_class_id (Long Integer)
The unique identifier for the ticket class. For example, "ticket_class_id": "27000000011376" identifies the ticket class with ID 27000000011376. - ticket_name (String)
The name of the ticket. For example, "ticket_name": "Free" indicates the ticket name is "Free." - purchased_by (String)
The email address of the purchaser. For example, "purchased_by": "sam@zoho.com" specifies the purchaser's email as sam@zoho.com. - status (Integer)
The status of the attendee. For example, "status": 1 indicates that the attendee is attending. Possible values include:- 0 - Not Attending
- 1 - Attending
- status_string (String)
A textual representation of the attendee's status. For example, "status_string": "attending" indicates that the attendee is attending. - affiliate_name (String)
The name of the affiliate. For example, "affiliate_name": "Affiliate X" specifies the affiliate name as Affiliate X. - promo_code (String)
The promo code used by the attendee. For example, "promo_code": "PROMO123" indicates the promo code is PROMO123. - contact (Object)
Contains details of the contact.- first_name (String)
The first name of the contact. For example, "first_name": "sam" identifies the contact's first name as Sam. - last_name (String)
The last name of the contact. For example, "last_name": "peter" identifies the contact's last name as Peter. - email (String)
The email address of the contact.
For example, "email": "sam@zoho.com" specifies the contact's email as sam@zoho.com. - mobile_no (Integer)
The mobile number of the contact.
For example, "mobile_no": "9876543210" provides the contact's phone number.
- first_name (String)
- created_time (String)
The timestamp of attendee creation in UTC format. For example, "created_time": "2024-04-18T12:10:53Z" specifies the date and time when the attendee was created. - last_modified_time (String)
The timestamp of the last modification of the attendee in UTC format. For example, "last_modified_time": "2024-04-18T12:10:53Z" specifies the date and time of the last modification.
URL
Copied/v3/portals/{portal_id}/events/{event_id}/attendees/{attendees_id}Example
Copiedhttps://zohoapis.com/backstage/v3/portals/19593237/events/2000000116588/attendees/8649000132755104Sample Response
Copied{
"id": "25000000121431",
"portal": "20942323",
"event_id": "25000000016003",
"order_id": "25000000121424",
"ticket_id": "250000001214242",
"ticket_class_id": "27000000011376",
"ticket_name": "Free",
"purchased_by": "sam@zoho.com",
"status": 1,
"status_string": "attending",
"affiliate_name": null,
"promo_code": null,
"contact": {
"first_name": "sam",
"last_name": "peter",
"email": "sam@zoho.com",
"mobile_no": "9876543210"
},
"created_time": "2024-04-18T12:10:53Z",
"last_modified_time": "2024-04-18T12:10:53Z"
}