---
title: "List visible users"
method: GET
path: "/users"
tags: ["Users"]
---

# List visible users

`GET /users`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/users`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `app-key`
  - API key in query parameter `api_key` and API key in query parameter `app_key`

The users this user can see. Any user may call it; `/admin/users` is the administrator view of the same data.

## Query parameters

- `conditions[email]` string
- `conditions[phone]` string
- `conditions[admin]` boolean
- `conditions[including_inactive]` boolean
- `page` integer
- `per_page` integer

## Response `200`

Successful Response

- object
  - `entries` UserAll[], required
    - `id` integer: Unique identifier
    - `account_id` integer: Account ID of the user
    - `full_name` string: Full name of the user
    - `api_key` string: The api key of the user. You can use this api key to perform requests using our api.
    - `last_seen_at` string, nullable: Timestamp of when the user was last logged in
    - `deleted_at` string, nullable: Timestamp when user was deleted (if inactive)
    - `mfa_requested_at` string, nullable: Timestamp when user requested multi-factor authentication
    - `data_reassigned_at` string, nullable: Timestamp when data was reassigned
    - `reassign_data_to_user_id` integer: User ID to reassign data to when deleting a user. If not specified, the data owned by the deleted user will be reassigned to the account admin making the request.
    - `w2lid` string: The web-to-lead ID of the user. You can use this ID to setup [web-to-leads forms]().
    - `other_emails` object[]: Additional email addresses of the user
      - `id` integer
      - `email` string
    - `created_at` string: Timestamp when the record was created (time zone in user's time zone).
    - `updated_at` string: Timestamp when the record was last touched (time zone in user's time zone).
    - `manager_id` integer, nullable: Returns the user_id of this user's manager. (obsolete)
    - `team_id` integer, nullable: Returns the team_id of this user.
    - `email` string: Email address of the user
    - `level` integer: Level of the user
    - `name` string: Username
    - `first_name` string: The first name of the user
    - `last_name` string: The last name of the user
    - `is_account_admin` boolean: Whether or not the user is an account admin.
    - `avatar_thumb_url` string, nullable: The avatar thumbnail URL
    - `mobile_number` string, nullable: Mobile number of the user
    - `date_format` string: Date format of the user
    - `time_format` string: Time format of the user
    - `is_allowed_to_export` boolean: Is user allowed to export
    - `is_allowed_to_delete` boolean: Is user allowed to delete
    - `is_allowed_to_send_campaigns` boolean: Is user allowed to send campaigns
    - `is_allowed_to_merge_records` boolean: Is user allowed to merge records
    - `is_google_apps_enabled` boolean
    - `read_only` boolean: Is user read only
    - `mfa_enabled` boolean: Is multi-factor authentication enabled for this user
    - `phone_number_display_format` 'national' | 'dashed' | 'spaces' | 'null', nullable: The user's phone number display preference; null inherits the account default
    - `currency` object
      - `id` integer
      - `name` string
      - `code` string
      - `symbol` string
      - `decimal_places` integer
    - `csv_column_separator` string: CSV column separator
    - `csv_decimal_mark` string: CSV decimal mark
    - `pipeline_email_client` boolean: Use Pipeline email client for links
    - `time_zone` string: The timezone identifier for the user (as defined by <a href="http://www.iana.org/time-zones" target="_blank">IANA</a>).
  - `pagination` Pagination, required: Paging details returned alongside `entries` on every paginated list.
    - `page` integer: The page returned. Request another with `?page=N`.
    - `per_page` integer: Page size. `?per_page=N`, capped at 200.
    - `total` integer: Total number of records matching the request across all pages.
    - `pages` integer: Number of pages at this `per_page`.
    - `total_in_account` integer, nullable: Total number of records of this type visible to you before filters were applied. Null when not computed for the endpoint.
    - `page_var` string: Name of the query parameter that selects the page. Always `page`.
    - `url` string, nullable: Path of the request, when the endpoint reports it.

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)