# List users Returns the people on your account: their name, contact details, date of birth, address, and a value for every custom attribute the account collects about a person. The `nice` block repeats the same values rendered for display - the phone number formatted for its country, the address as one string, select ids resolved to their labels - so a table can be drawn without resolving anything yourself. This is the largest response the API produces. An account with a few hundred people and a normal set of custom attributes runs to megabytes, so page it rather than reading it whole, and filter it if you are looking for someone in particular. Endpoint: GET /api/v2/user Version: 2.0.0 Security: default ## 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., - `extras` (array) A list of extras to include in the response. These are objects or arrays that are not part of the model's primary attributes, such as stats and counts. For fast responses, avoid requesting them if you don't need them. - `with` (array) A list of relations to include in the response. May be single records or collections. It is often more efficient to retrieve this way, to avoid follow-up API calls. ## 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 | null) - `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) - `data.object.address.coordinates.longitude` (string) - `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) - `data.object.address.longitude` (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) - `data.nice.address.longitude` (string) - `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.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` (array) - `data.permissions` (object) - `data.permissions.read` (boolean) - `data.permissions.update` (boolean) - `data.permissions.delete` (boolean) - `data.attributes` (array) - `data.id` (integer) - `data.name` (string) - `first_page_url` (string) - `from` (integer) - `next_page_url` (string) - `path` (string) - `per_page` (integer) - `prev_page_url` (string | null) - `to` (integer)