Users

List users

get/admin/users

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/admin/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

Query parameters

conditions[email]string

Find a user with the exact email

conditions[admin]boolean

Return only account administrators

conditions[including_inactive]boolean

Return all users, including inactive ones (default returns only active)

conditions[user_level]integer

Return users based on level:

  • 1 - only basic users
  • 2 - only manager users
  • 3 - only executive users

Response

Successful Response

Example response

{
  "entries": [
    {
      "id": 13,
      "account_id": 1234,
      "full_name": "Sam Okafor",
      "api_key": "abcd1234",
      "last_seen_at": "2018/05/02 12:35:05 -0700",
      "deleted_at": "2018/05/02 12:35:05 -0700",
      "mfa_requested_at": "2018/05/02 12:35:05 -0700",
      "data_reassigned_at": "2018/05/02 12:35:05 -0700",
      "reassign_data_to_user_id": 1234,
      "w2lid": "abcd1234",
      "other_emails": [
        {
          "id": 1,
          "email": "bob@smith.com"
        }
      ],
      "created_at": "2026-09-01 14:22:07",
      "updated_at": "2026-09-01 14:22:07",
      "manager_id": 1234,
      "team_id": 1234,
      "email": "sam.okafor@northwind.example",
      "level": 2,
      "name": "Sam Okafor",
      "first_name": "Sam",
      "last_name": "Okafor",
      "avatar_thumb_url": "https://s3.amazonaws.com/pipelinedeals/avatars/1234/thumb/wolverine-avatar.png",
      "mobile_number": "123-456-7890",
      "date_format": "us",
      "time_format": "US",
      "is_allowed_to_export": true,
      "is_allowed_to_merge_records": true,
      "phone_number_display_format": "national",
      "currency": {
        "id": 1,
        "name": "US Dollar",
        "code": "USD",
        "symbol": "$"
      },
      "csv_column_separator": ",",
      "csv_decimal_mark": ".",
      "time_zone": "America/New_York"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 200,
    "total": 670,
    "pages": 4,
    "total_in_account": 1204,
    "page_var": "page",
    "url": "/api/v3/deals.json"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.