Get all event members
The "Get All Event Members" API allows users to retrieve detailed information about all members associated with a specific event within their Zoho Backstage portal. Users must provide the portal_id and event_id to access this information, which uniquely identifies the portal and the event.
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
OAuth Scope
zohobackstage.event.READ
Path Parameters
- portal_id (Long Integer)
The unique identifier of the portal from which you want to retrieve event members. 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 member details. For example, "event_id": "3000000000022" specifies the event with ID 3000000000022.
Response Structure and Field Explanations
The response provides a JSON object containing an array of member objects. Each member object includes detailed information about the event member. Below are the fields included in the response, along with explanations:
- members (Array of Objects)
This array contains objects, each representing an event member. - id (Long Integer)
The unique identifier assigned to the member. For example, "id": "20000000000001" identifies the member with ID 20000000000001. - email (String)
The email address of the member. For instance, "email": "sam@zoho.com" specifies that the member's email is sam@zoho.com. - role (String)
The role assigned to the member within the event. For example, "role": "Event Owner" indicates that this member is the event owner. - status (Integer)
This field represents the current status of the member. Possible values include:0 - Invited
1 - Joined
- status_string (String)
A textual representation of the member's status. For example, "status_string": "joined" indicates that the member has joined the event. - featured (Boolean)
This field indicates whether the member is featured. For example, "featured": false indicates that the member is not featured. - joined_on (String)
The date and time when the member joined the event. For example, "joined_on": "2024-04-03T07:40:19Z" specifies the exact date and time the member joined. - added_on (String)
The date and time when the member was added to the event. For example, "added_on": "2024-04-03T07:12:40Z" specifies when the member was added. - first_name (String)
The first name of the member. For example, "first_name": "Sam" identifies the member's first name as Sam. - last_name (String)
The last name of the member. For example, "last_name": "Peter" identifies the member's last name as Peter. - company (String)
The company where the member works. For example, "company": "ZOHO" indicates that the member works at ZOHO. - designation (String)
The member's designation within their company. For example, "designation": "Manager" identifies the member's job title as Manager. - telephone (String)
The member's telephone number. For example, "telephone": "9988776655" provides the member's phone number. - alternate_telephone (String)
An alternate phone number for the member. For example, "alternate_telephone": "8877665544" provides an additional contact number.
URL
Copied/v3/portals/{portal_id}/events/{event_id}/members
Example
Copiedhttps://zohoapis.com/backstage/v3/portals/19593237/events/3000000000022/members
Sample Response
Copied{
"members": [
{
"id": "20000000000001",
"email": "sam@zoho.com",
"role": "Event Owner",
"status": 1,
"status_string": "joined",
"featured": false,
"joined_on": "2024-04-03T07:40:19Z",
"added_on": "2024-04-03T0712:40:19Z",
"first_name": "sam",
"last_name": "peter",
"company": "ZOHO",
"designation": "Manager",
"telephone": "9988776655",
"alternate_telephone": "8877665544"
}
]
}