Structures

List users by role

Changed on

Lists the users assigned to a role, deduplicated across structure instances, one entry per user. Each entry samples the user's assigned structures per structure type.

post/structures/v1/roles/{role_id}/members/list

Request

  • Base URL
    https://api.mitti.com
  • Auth
    HTTP bearer

Path parameters

role_idstring required

Required. The unique identifier of the role.

Request body

page_sizeinteger

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

offsetinteger

Optional. The number of results to offset by.

sort_direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'
max_structures_per_userinteger

Optional. Maximum structures sampled per user (1-50), applied PER structure_type_id, not globally. Omit it to sample none. total_structure_count_by_type_id is never capped.

Response

A successful response.

total_countinteger

The total count of distinct users assigned to the role.

offsetinteger

The offset for the requested page.

Changes