Get all portal members

The "Get All Portal Members" API allows users to retrieve detailed information about all members within a specific Zoho Backstage portal. Each member's details, including their role, status, and contact information, are provided in the response.

Header

Authorization: Zoho-OAuth token d92d4xxxxxxxxxxxxx15f52

OAuth Scope 

zohobackstage.portal.READ

Path Parameters  

• portal_id (Long Integer) 
  This parameter represents the unique identifier of the portal from which you want to retrieve member information. For example, "portal_id": "19593237" would request member details for the portal with that ID.

Response Structure and Field Explanations  

The response comprises an array of member objects, each containing detailed information about individual portal members. Below are the fields included in the response, along with their explanations:

• id (Long Integer) 
  The id field uniquely identifies each member within the portal. For example, "id": "20000000000001" signifies that the member has the unique ID 20000000000001. This ID is crucial for referencing specific members within the portal.
• email (String) 
  The email field contains the email address of the portal member. For instance, "email": "sam@zoho.com" indicates that the member's email address is sam@zoho.com. This field is vital for communication and notifications.
• role (String) 
  The role field specifies the member’s role within the event. For example, "role": "Event Owner" indicates that the member is the Event Owner, responsible for managing the event within the portal.
• status (Integer) 
  The status field indicates the current status of the member in numerical form. For example, "status": 1" means the member has joined the portal. The status values are:

  • 0: Invited (the member has been invited but has not yet joined)

  • 1: Joined (the member has accepted the invitation and joined the portal)

• status_string (String) 
  This field provides the status of the member in a string format, corresponding to the status value. For instance, "status_string": "joined" indicates that the member has joined the portal.
• joined_on (String) 
  The joined_on field contains the date and time when the member joined the portal, provided in UTC format. For example, "joined_on": "2024-04-03T07:40:19Z" indicates that the member joined on April 3, 2024, at 07:40:19 UTC.
• added_on (String) 
  The added_on field specifies the date and time when the member was added to the portal, in UTC format. For instance, "added_on": "2024-04-03T07:12:40Z" shows that the member was added on April 3, 2024, at 07:12:40 UTC.
• first_name (String) 
  The first_name field holds the first name of the portal member. For example, "first_name": "Sam" indicates that the member's first name is Sam.
• last_name (String) 
  The last_name field contains the last name of the portal member. For instance, "last_name": "Peter" signifies that the member's last name is Peter.
• company (String) 
  The company field provides the name of the company where the member works. For example, "company": "ZOHO" indicates that the member works at Zoho Corporation.
• designation (String) 
  The designation field specifies the member’s role or title within their company. For instance, "designation": "Manager" suggests that the member holds the title of Manager.
• telephone (String) 
  The telephone field contains the primary telephone number of the member. For example, "telephone": "9988776655" indicates that the member's primary contact number is 9988776655.
• alternate_telephone (String) 
  The alternate_telephone field provides an alternate contact number for the member. For instance, "alternate_telephone": "8877665544" indicates that the member has an alternate contact number of 8877665544.