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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Members
Manage Bookings Services and Settings
Read Members and Contacts - all read permissions
Read Members
Manage Members and Contacts - all permissions
Learn more about permission scopes.
Method Declaration
Method Parameters

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

Return Type:Promise<ListMembersResponse>
Was this helpful?