listMembers( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Lists site members, given the provided paging and fieldsets.

  • PUBLIC fieldset returns id and profile object. status, privacyStatus and activityStatus are returned as UNKNOWN.
  • FULL fieldset returns all fields.
Permissions
Manage Bookings Services and Settings
Manage Members
Read Members and Contacts - all read permissions
Read Members
Manage Portfolio
Manage Restaurants - all permissions
Manage Members and Contacts - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsListMembersOptions

Options for paging, sorting, and specifying fields to return.

Returns
Return Type:Promise<ListMembersResponse>
Did this help?