List members of a structure

Returns the users assigned directly to a structure, each with their role and user details. Users who inherit membership from an ancestor structure are not included. Filter by role, by a partial match on name or email, or by active status, and page through results with page_size and offset. Use total_membership_count to size the full result set.

Lists the users assigned directly to a structure. Each entry pairs the membership with the user's details and the role they hold, so you can render a member list without a second lookup.

Only direct memberships are returned. Users who reach this structure through an inherited membership from an ancestor are not included.

Requirements

Narrow the result set with filter:

  • role_id returns only the members holding a specific role.
  • query matches partially against a user's first name, family name or email.
  • user_status includes or excludes deactivated users.

Page through results with page_size and offset, and sort by name with sort_direction. page_size defaults to 1000 and accepts a value between 1 and 1000. Use total_membership_count on the response to size the full result set.

Path Params
string
required

The unique identifier of the structure to list users for.

Body Params

Request message to list users directly assigned to a structure.

filter
object

Filters to apply against the list of users.

int32

Optional. The maximum number of users to return. Default of 1000.
You can specify a value between 1 to 1000.

string
enum
Defaults to SORT_DIRECTION_UNSPECIFIED

Optional. The sort direction for query results (ascending or descending).

Allowed:
int32

Optional. The number of results to offset by.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json