Get all attendee profile

The "Get All Attendee Profiles" API allows you to retrieve a complete list of attendee profiles for a specific event in a Zoho Backstage portal. The response is provided in a paginated format, including attendee details.

Header

Authorization: Zoho-OAuth token d92d4xxxxxxxxxxxxx15f52

OAuth Scope

zohobackstage.attendee.READ

Path Parameters

• portal_id (Long Integer)
  The unique identifier of the portal hosting the event. 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 profiles. For example, "event_id": "2000000116588" specifies the event with ID 2000000116588.

Response Structure and Field Explanations

The response contains a paginated JSON object with attendee profile details. Below are the fields included:

• Pagination (Object)
  Contains metadata about the response pagination.
  • total_count (Integer)
    The total number of attendee profiles available. For example, "total_count": 1000" indicates there are 1000 attendees.
  • page (Integer)
    The current page number in the response. For example, "page": 1" specifies the first page.
  • per_page (Integer)
    The number of attendees displayed per page. For example, "per_page": 20" displays 20 attendees per page.
  • total_pages (Integer)
    The total number of pages available. For example, "total_pages": 50" indicates there are 50 pages in total.
  • has_more_items (Boolean)
    Indicates whether more items are available on subsequent pages. For example, "has_more_items": true" means more pages are available.
• Members (Array of Objects)
  Contains the attendee profiles. Each attendee is represented by an object with the following fields:
  • id (String)
    The unique identifier for the attendee. For example, "id": "25000000121431" identifies the attendee with ID 25000000121431.
  • email (String)
    The email address of the attendee. For example, "email": "sam@zoho.com" specifies the attendee's email address.
  • status (Integer)
    The attendance status of the attendee.  For example, "status": 1" indicates the attendee is attending. Possible values:
    0 → Not Attending
    1 → Attending
  • first_name (String)
    The first name of the attendee.For example, "first_name": "Sam" specifies the attendee's first name.
  • last_name (String)
    The last name of the attendee. For example, "last_name": "Peter" specifies the attendee's last name.
  • company (String)
    The company name of the attendee. For example, "company": "Zoho Corp" specifies the attendee's company.
  • designation (String)
    The job title or designation of the attendee. For example, "designation": "Manager" specifies the attendee's designation.
  • description (String | Null)
    Additional description provided by the attendee. For example, "description": "Keynote Speaker" specifies the attendee's role or description.
  • skills (String | Null)
    Skills or expertise of the attendee. For example, "skills": "Data Analysis, Marketing" lists the attendee's skills.
  • telephone (String)
    The primary contact number of the attendee. For example, "telephone": "+1-123-456-7890" provides the attendee's contact number.
  • alternate_telephone (String | Null)
    An alternate contact number, if available. For example, "alternate_telephone": "+1-098-765-4321" provides an additional contact number.
  • address (String | Null)
    The address of the attendee. For example, "address": "123 Main St, Springfield, USA" specifies the attendee's address.