# List the people holding a role

Returns everyone in this account who holds the role named in the URL. Each row is
the person's full record, not a membership record, with `object.added_at` giving
the moment they were assigned the role.
Only assignments made in the account you are calling as are returned. A role that
accounts below this one also use lists its members separately in each of them.

Endpoint: GET /api/v2/account/role/{role_id}/user
Version: 2.0.0
Security: default

## Path parameters:

  - `role_id` (integer, required)
    The ID of the role.

## Query parameters:

  - `per_page` (integer)
    The number of results to return per page. The higher the number the longer the request may take.
It is highly recommended to use this to avoid timeouts as your data grows.
Used in conjunction with the `page` parameter to paginate results.

  - `page` (integer)
    The page of results to return. Used in conjunction with the `per_page` parameter to paginate
results. If not specified, defaults to 1.
The response's next_page_url will be null if there are no
more pages.

  - `filter` (array)
    A filter to apply to the results. Declared as an array of objects, where each object
contains an attr (attribute code), operator and value key. Examples:

?filter[0]['attr']=name&filter[0][operator]=like&filter[0][value]=luke 

?filter[0]['attr']=id&filter[0][operator]=>&filter[0][value]=265 

See the filters documentation for more details on how to use this.

  - `sort_by` (string)
    The field to sort the results by. No ordering is applied unless you specify one, so
row order is not guaranteed. Always send it when paging through a list, otherwise
records can repeat or be missed between pages.
Example: id

  - `sort_order` (string)
    The direction to sort the results by. Can be 'asc' or 'desc', default is 'asc'.

  - `_locale` (string)
    The locale to use for the response. This primarily affects the results of the `nice` field, which
contain human-readable labels and terms, as well as locale-specific date formats.,

## Header parameters:

  - `Rosterfy-Platform` (string)

## Response 200 fields (application/json):

  - `current_page` (integer)

  - `data` (array)

  - `data.object` (object)

  - `data.object.id` (integer)

  - `data.object.id_token` (string)

  - `data.object.account_id` (integer)

  - `data.object.email` (string)

  - `data.object.force_reset_password` (integer)

  - `data.object.password_expires_at` (string | null)

  - `data.object.first_name` (string)

  - `data.object.middle_name` (string | null)

  - `data.object.last_name` (string)

  - `data.object.preferred_name` (string | null)

  - `data.object.phone` (string)

  - `data.object.dob` (string)

  - `data.object.picture` (string | null)

  - `data.object.picture_status` (integer)

  - `data.object.is_subscribed` (integer)

  - `data.object.is_subscribed_transactional` (integer)

  - `data.object.is_unreachable` (integer)

  - `data.object.is_unreachable_sms` (integer)

  - `data.object.terms` (integer)

  - `data.object.rating` (string)

  - `data.object.shift_privacy` (integer)

  - `data.object.is_team_leader` (integer)

  - `data.object.email_verified` (integer)

  - `data.object.login_lockout_attempts` (integer)

  - `data.object.login_lockout_at` (string | null)

  - `data.object.login_lockout_email_sent_at` (string | null)

  - `data.object.last_login_at` (string)

  - `data.object.last_app_login_at` (string | null)

  - `data.object.is_archived` (integer)

  - `data.object.last_activated` (string | null)

  - `data.object.from_source` (string | null)

  - `data.object.delete_requested_at` (string | null)

  - `data.object.deleted_at` (string | null)

  - `data.object.is_erased` (integer)

  - `data.object.created_at` (string)

  - `data.object.updated_at` (string)

  - `data.object.deleted_by` (string | null)

  - `data.object.interests` (string | null)

  - `data.object.address` (object)

  - `data.object.address.iso` (string)

  - `data.object.address.region_code` (string)

  - `data.object.address.coordinates` (object)

  - `data.object.address.coordinates.latitude` (string | null)

  - `data.object.address.coordinates.longitude` (string | null)

  - `data.object.address.street_address_1` (string)

  - `data.object.address.street_address_2` (string | null)

  - `data.object.address.street_address_3` (string | null)

  - `data.object.address.city` (string)

  - `data.object.address.postcode` (string)

  - `data.object.address.region` (string)

  - `data.object.address.country` (string)

  - `data.object.address.latitude` (string | null)

  - `data.object.address.longitude` (string | null)

  - `data.object.added_at` (string)

  - `data.nice` (object)

  - `data.nice.rrn` (string)

  - `data.nice.address` (string)

  - `data.nice.address_oneline` (string)

  - `data.nice.address.country` (string)

  - `data.nice.address.country:raw` (string)

  - `data.nice.address.city` (string)

  - `data.nice.address.region` (string)

  - `data.nice.address.region:raw` (string)

  - `data.nice.address.postcode` (string)

  - `data.nice.address.street_address_1` (string)

  - `data.nice.address.street_address_2` (string | null)

  - `data.nice.address.street_address_3` (string | null)

  - `data.nice.address.latitude` (string | null)

  - `data.nice.address.longitude` (string | null)

  - `data.nice.family_id` (string | null)

  - `data.nice.has_family_members` (string)

  - `data.nice.manages_family` (boolean)

  - `data.nice.family_manager` (string)

  - `data.nice.family_member` (string)

  - `data.nice.is_family_member` (boolean)

  - `data.nice.is_engaged` (string)

  - `data.nice.is_engaged:raw` (boolean)

  - `data.nice.last_engaged_at` (string | null)

  - `data.nice.last_engaged_at:raw` (string | null)

  - `data.nice.created_at` (string)

  - `data.nice.created_at__date` (string)

  - `data.nice.created_at__time` (string)

  - `data.nice.created_at__offset` (string)

  - `data.nice.created_at__offset_minutes` (integer)

  - `data.nice.created_at__dayofweek` (string)

  - `data.nice.email_verified` (string)

  - `data.nice.from_source` (string)

  - `data.nice.interests` (string | null)

  - `data.nice.interests:value` (string | null)

  - `data.nice.interests:array` (string | null)

  - `data.nice.is_subscribed_transactional` (string)

  - `data.nice.is_team_leader` (string)

  - `data.nice.last_login_at` (string)

  - `data.nice.last_login_at__date` (string)

  - `data.nice.last_login_at__time` (string)

  - `data.nice.last_login_at__offset` (string)

  - `data.nice.last_login_at__offset_minutes` (integer)

  - `data.nice.last_login_at__dayofweek` (string)

  - `data.nice.middle_name` (string)

  - `data.nice.picture_status` (string)

  - `data.nice.picture_status:value` (integer)

  - `data.nice.picture_status:array` (string)

  - `data.nice.shift_privacy` (string)

  - `data.nice.updated_at` (string)

  - `data.nice.updated_at__date` (string)

  - `data.nice.updated_at__time` (string)

  - `data.nice.updated_at__offset` (string)

  - `data.nice.updated_at__offset_minutes` (integer)

  - `data.nice.updated_at__dayofweek` (string)

  - `data.nice.first_name` (string)

  - `data.nice.last_name` (string)

  - `data.nice.preferred_name` (string)

  - `data.nice.phone:qr_code_value` (string)

  - `data.nice.phone` (string)

  - `data.nice.phone:raw` (string)

  - `data.nice.phone:local_au` (string)

  - `data.nice.dob` (string)

  - `data.nice.dob__dayofweek` (string)

  - `data.nice.is_subscribed` (string)

  - `data.nice.terms` (string)

  - `data.nice.name` (string)

  - `data.nice.age` (integer)

  - `data.nice.age_months` (string)

  - `data.nice.info` (string)

  - `data.nice.preferred_first_name` (string)

  - `data.nice.delete_requested` (boolean)

  - `data.nice.updated_hours` (number)

  - `data.nice.is_community_user` (boolean)

  - `data.nice.timezone` (string)

  - `data.relations` (object)

  - `data.relations.user_checkpoint` (object)

  - `data.relations.user_checkpoint.object` (object)

  - `data.relations.user_checkpoint.object.id` (integer)

  - `data.relations.user_checkpoint.object.user_checkpoint_type_id` (string | null)

  - `data.relations.user_checkpoint.object.name` (string)

  - `data.relations.user_checkpoint.object.label` (string)

  - `data.relations.user_checkpoint.object.permissions` (object)

  - `data.relations.user_checkpoint.object.permissions.all` (string)

  - `data.relations.user_checkpoint.object.actions` (array)

  - `data.relations.user_checkpoint.object.is_inheritable` (integer)

  - `data.relations.user_checkpoint.object.sort_order` (integer)

  - `data.relations.user_checkpoint.object.deleted_at` (string | null)

  - `data.relations.user_checkpoint.object.created_at` (string)

  - `data.relations.user_checkpoint.object.updated_at` (string)

  - `data.relations.user_checkpoint.nice` (object)

  - `data.relations.user_checkpoint.nice.rrn` (string)

  - `data.relations.user_checkpoint.nice.content_id` (integer)

  - `data.relations.user_checkpoint.nice.account_name_path` (string)

  - `data.relations.user_checkpoint.nice.is_foreign_account` (boolean)

  - `data.relations.user_checkpoint.permissions` (object)

  - `data.relations.user_checkpoint.permissions.read` (boolean)

  - `data.relations.user_checkpoint.permissions.update` (boolean)

  - `data.relations.user_checkpoint.permissions.delete` (boolean)

  - `data.relations.user_type` (object)

  - `data.relations.user_type.object` (object)

  - `data.relations.user_type.object.id` (integer)

  - `data.relations.user_type.object.account_branding_id` (string | null)

  - `data.relations.user_type.object.name` (string)

  - `data.relations.user_type.object.code` (string)

  - `data.relations.user_type.object.profile_form_id` (string | null)

  - `data.relations.user_type.object.training_ids` (string | null)

  - `data.relations.user_type.object.registration_form_id` (string | null)

  - `data.relations.user_type.object.shift_limit` (integer)

  - `data.relations.user_type.object.shift_max_time` (string | null)

  - `data.relations.user_type.object.max_shift_length` (integer)

  - `data.relations.user_type.object.min_shift_length` (integer)

  - `data.relations.user_type.object.min_consecutive_rest_time_per_week` (integer)

  - `data.relations.user_type.object.max_work_days_per_week` (integer)

  - `data.relations.user_type.object.gap_between_shifts` (integer)

  - `data.relations.user_type.object.group_leader_attributes` (string | null)

  - `data.relations.user_type.object.deleted_at` (string | null)

  - `data.relations.user_type.object.created_at` (string)

  - `data.relations.user_type.object.updated_at` (string)

  - `data.relations.user_type.object.uuid` (string)

  - `data.relations.user_type.nice` (array)

  - `data.relations.user_type.permissions` (object)

  - `data.relations.user_type.permissions.read` (boolean)

  - `data.relations.user_type.permissions.update` (boolean)

  - `data.relations.user_type.permissions.delete` (boolean)

  - `data.relations.account` (object)

  - `data.relations.account.object` (object)

  - `data.relations.account.object.id` (integer)

  - `data.relations.account.object.parent_id` (integer)

  - `data.relations.account.object.account_type_id` (integer)

  - `data.relations.account.object.path` (string)

  - `data.relations.account.object.name` (string)

  - `data.relations.account.object.config` (object)

  - `data.relations.account.object.config.active_settings` (array)

  - `data.relations.account.object.meta` (array)

  - `data.relations.account.object.visibility_rules` (array)

  - `data.relations.account.object.status` (string)

  - `data.relations.account.object.status_reason` (string | null)

  - `data.relations.account.object.sort_order` (integer)

  - `data.relations.account.object.start_timestamp` (string | null)

  - `data.relations.account.object.end_timestamp` (string | null)

  - `data.relations.account.object.notes` (string | null)

  - `data.relations.account.object.contact_firstname` (string | null)

  - `data.relations.account.object.contact_lastname` (string | null)

  - `data.relations.account.object.contact_email` (string | null)

  - `data.relations.account.object.contact_phone` (string | null)

  - `data.relations.account.object.support_manager_email` (string)

  - `data.relations.account.object.allow_deletion_request` (integer)

  - `data.relations.account.object.organization_type` (string | null)

  - `data.relations.account.object.contract_start_date` (string)

  - `data.relations.account.object.contract_end_date` (string)

  - `data.relations.account.object.billing_contact_email` (string)

  - `data.relations.account.object.billing_support_email` (string)

  - `data.relations.account.object.is_enabled` (integer)

  - `data.relations.account.object.additional_billing_support_email` (string)

  - `data.relations.account.object.delete_requested_at` (string | null)

  - `data.relations.account.object.is_archived` (integer)

  - `data.relations.account.object.trial_ends_at` (string | null)

  - `data.relations.account.object.can_erase` (integer)

  - `data.relations.account.object.deleted_at` (string | null)

  - `data.relations.account.object.is_erased` (integer)

  - `data.relations.account.object.created_at` (string)

  - `data.relations.account.object.updated_at` (string)

  - `data.relations.account.nice` (object)

  - `data.relations.account.nice.rrn` (string)

  - `data.relations.account.nice.address` (string)

  - `data.relations.account.nice.address_oneline` (string)

  - `data.relations.account.nice.account_type_id` (integer)

  - `data.relations.account.nice.account_type_id:value` (integer)

  - `data.relations.account.nice.account_type_id:array` (integer)

  - `data.relations.account.nice.allow_deletion_request` (string)

  - `data.relations.account.nice.contact_firstname` (string)

  - `data.relations.account.nice.contact_lastname` (string)

  - `data.relations.account.nice.contact_phone:qr_code_value` (string)

  - `data.relations.account.nice.contact_phone` (string)

  - `data.relations.account.nice.contact_phone:raw` (string)

  - `data.relations.account.nice.contract_end_date` (string)

  - `data.relations.account.nice.contract_end_date__dayofweek` (string)

  - `data.relations.account.nice.contract_start_date` (string)

  - `data.relations.account.nice.contract_start_date__dayofweek` (string)

  - `data.relations.account.nice.name` (string)

  - `data.relations.account.nice.notes` (string)

  - `data.relations.account.nice.organization_type` (string | null)

  - `data.relations.account.nice.organization_type:value` (string | null)

  - `data.relations.account.nice.organization_type:array` (string | null)

  - `data.relations.account.nice.status` (string)

  - `data.relations.account.nice.status:value` (string)

  - `data.relations.account.nice.status:array` (string)

  - `data.relations.account.nice.status_reason` (string)

  - `data.relations.account.nice.created_at` (string)

  - `data.relations.account.nice.url` (string)

  - `data.relations.account.nice.branding_name` (string)

  - `data.relations.account.nice.branding_subtitle` (string | null)

  - `data.relations.account.nice.branding_logo` (string | null)

  - `data.relations.account.nice.branding_logo_mono` (string | null)

  - `data.relations.account.nice.branding_logo_stacked` (string | null)

  - `data.relations.account.nice.branding_banner` (string | null)

  - `data.relations.account.nice.branding_favicon` (string | null)

  - `data.relations.account.nice.branding_description` (string | null)

  - `data.relations.account.nice.branding_primary_color` (string)

  - `data.relations.account.nice.branding_complimentary_color` (string | null)

  - `data.relations.account.nice.branding_secondary_color` (string)

  - `data.relations.account.nice.register` (boolean)

  - `data.relations.account.nice.organisation_contact` (string)

  - `data.relations.account.nice.has_subaccount_approved_email_template` (boolean)

  - `data.relations.account.nice.has_subaccount_rejected_email_template` (boolean)

  - `data.relations.account.nice.parent_account_name` (string)

  - `data.relations.account.permissions` (object)

  - `data.relations.account.permissions.read` (boolean)

  - `data.relations.account.permissions.update` (boolean)

  - `data.relations.account.permissions.delete` (boolean)

  - `data.relations.family` (string | null)

  - `data.relations.family_user` (string | null)

  - `data.permissions` (object)

  - `data.permissions.read` (boolean)

  - `data.permissions.update` (boolean)

  - `data.permissions.delete` (boolean)

  - `data.attributes` (array)

  - `first_page_url` (string)

  - `from` (integer)

  - `next_page_url` (string)

  - `path` (string)

  - `per_page` (integer)

  - `prev_page_url` (string | null)

  - `to` (integer)