People

List people

Filtered request example — People at companies named Acme with lead status 2, changed in the last week:

curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.pipelinecrm.com/api/v3/people.json?conditions[person_company_name]=Acme&conditions[person_status][]=2&conditions[person_modified][selection]=last_7&sort=person_last_name&per_page=100"
get/people

Request

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

lead_sourceinteger

Returns records associated to the Lead source with this ID

person_all_emailsstring

Any of the person's email addresses (work, home, secondary) equals this value exactly. Several values may be given.

person_bounced'Yes' | 'No'

Returns records with the given bounced state

person_citystring

Returns records that match a LIKE query on the city field

person_company_namestring

Returns records that match a LIKE query on the name of the associated Company

person_countrystring

Returns records that match a LIKE query on the country field

person_created_by_userinteger

Returns records created by the User with this ID

person_emailstring

Returns records that match a LIKE query on the email address field

person_email2string

Returns records that match a LIKE query on the other email address field

person_email_instring

Work email address is exactly one of the given values; several values may be given.

person_faxstring

Returns records that match a LIKE query on the fax field

person_first_namestring

Returns records that match a LIKE query on the first_name field

person_full_namestring

Returns records that match a LIKE query on the full name (combination of first_name and last_name fields)

person_home_address_1string

Returns records that match a LIKE query on the home address 1 field

person_home_address_2string

Returns records that match a LIKE query on the home address 2 field

person_home_citystring

Returns records that match a LIKE query on the home city field

person_home_countrystring

Returns records that match a LIKE query on the home country field

person_home_emailstring

Returns records that match a LIKE query on the home email address field

person_home_phonestring

Returns records that match a LIKE query on the home_phone field

person_home_statestring

Returns records that match a LIKE query on the home state field

person_home_zipstring

Returns records that match a LIKE query on the home zip code field

person_idinteger

Returns records with this Person ID

person_import_namestring

Returns records that match a LIKE query on the import name field

person_is_key_contact'Yes' | 'No'

Returns records with the given key contact state

person_last_namestring

Returns records that match a LIKE query on the last_name field

person_linked_in_urlstring

LinkedIn URL contains this text.

person_mobilestring

Returns records that match a LIKE query on the mobile field

person_namestring

Returns records that match a LIKE query on the first_name or last_name fields

person_ownerinteger

Returns records owned by the User with this ID

person_owner_teaminteger

Returns records owned by members of the team with this ID

person_phonestring

Returns records that match a LIKE query on the phone field

person_phonesstring

Returns records that match a LIKE query on the phone, home_phone or mobile field

person_phones_containsstring

Any of the person's phone numbers contains these digits; formatting characters are ignored.

person_positionstring

Returns records that match a LIKE query on the position field

person_relationshipstring

Returns records that match a LIKE query on the relationship field

person_shared_withinteger[]

Returns records shared with the Users with these ID

person_simple_searchstring

Returns records that match a LIKE query on first_name, last_name, email or associated Company name

person_statestring

Returns records whose work state starts with this value. A US state name and its two-letter code match each other (Texas also returns TX)

person_statusinteger

Returns records associated to the Lead status with this ID

person_summarystring

Returns records that match a LIKE query on the summary field

person_tag_namesstring[]

Returns records that match a LIKE query on the tag names

person_tagsinteger[]

Returns records associated to the tags with these IDs

person_type'Lead' | 'Contact'

Returns records of the specified type - either Contact or Lead

person_unsubscribed'Yes' | 'No'

Returns records with the given unsubscribed state

person_websitestring

Returns records that match a LIKE query on the website field

person_work_address_1string

Returns records that match a LIKE query on the work address 1 field

person_work_address_2string

Returns records that match a LIKE query on the work address 2 field

person_work_zipstring

Work postal code starts with this text. Alias of person_zip.

person_zipstring

Returns records that match a LIKE query on the zip code field

company_addressstring

Return records that have an address that exactly matches or starts with the provided string

company_address2string

Return records that have a secondary address that exactly matches or starts with the provided string

company_citystring

Return records that have a city that exactly matches or starts with the provided string

company_countrystring

Country starts with this text (case-insensitive).

company_created_by_userinteger

Return records that were created by the given user

company_descriptionstring

Return records that have a description that exactly matches or starts with the provided string

company_emailstring

Return records that have an email that exactly matches or starts with the provided string

company_faxstring

Return records that have a fax number that exactly matches or starts with the provided string

company_idinteger

The company with given company_id. Note: you can specify a comma-separated list of ids to retrieve more companies at once

company_import_namestring

Return records that have an import name that exactly matches or starts with the provided string

company_is_customer'Yes' | 'No'

Return records that are customers

company_linked_in_urlstring

LinkedIn URL contains this text.

company_namestring

Return records that have a name that exactly matches or starts with the provided string

company_name_eqstring

Return records that have a name that exactly matches the provided string

company_ownerinteger

Return records that have an owner with the given ID

company_owner_teaminteger

Return records that have an owner in the given team

company_phonestring

Return records that have a phone number that exactly matches or starts with the provided string

company_phone2string

Second phone number contains these digits; formatting characters are ignored.

company_phone3string

Third phone number contains these digits; formatting characters are ignored.

company_phone4string

Fourth phone number contains these digits; formatting characters are ignored.

company_phones_containsstring

Any of the company's phone numbers contains these digits; formatting characters are ignored.

company_shared_withinteger[]

Return records that have been shared with the given users

company_statestring

Return records that have a state that exactly matches or starts with the provided string

company_tagsinteger[]

Return records that have the given tag IDs

company_webstring

Return records that have a website that exactly matches or starts with the provided string

company_worked_on_byinteger

Return records that have been worked on by the given user

company_zipstring

Return records that have a postal code that exactly matches or starts with the provided string

customer_health_scoreinteger

Return records that have a customer health score that exactly matches the provided integer

next_milestone_namestring

The customer's next milestone name contains this text.

next_milestone_statusstring

The customer's next milestone has this status: not_started, in_progress, blocked or complete, or the number it is stored as (0 to 3). The next milestone is the earliest one not yet complete, so complete normally matches nothing. none or __NONE__ matches customers with no next milestone, __HAS_VALUE__ those with one; any other value matches nothing.

Filters as bracketed query parameters, for example ?conditions[person_owner][]=13&conditions[person_created][from_date]=2026-01-01. Each key below is one filter; see the Filtering guide for the value formats (ids, lists, date ranges, number ranges, custom fields) and the example above for a complete request.

{
  "lead_source": 63424,
  "person_all_emails": "jane@example.com",
  "person_city": "New York Ci",
  "person_company_id": 123,
  "person_company_name": "Inc.",
  "person_converted": "last_30",
  "person_converted_at": "last_30",
  "person_country": "United States",
  "person_created": "last_30",
  "person_created_at": "last_30",
  "person_created_by_user": 145735,
  "person_date_of_first_activity": "last_30",
  "person_days_since_last_activity": {
    "from": 1000,
    "to": 5000
  },
  "person_email_in": "jane@example.com",
  "person_fax": "(514) 897",
  "person_first_name": "John",
  "person_full_name": "John D. Rockefel",
  "person_home_address_1": "123 Fake St.",
  "person_home_address_2": "Suite 101",
  "person_home_city": "New York Ci",
  "person_home_country": "United States",
  "person_home_phone": "(514) 673",
  "person_home_state": "Dakota",
  "person_home_zip": "64",
  "person_hours_to_first_activity": {
    "from": 1000,
    "to": 5000
  },
  "person_id": 1,
  "person_id_not": 123,
  "person_import_name": "Import",
  "person_imported_at": "last_30",
  "person_last_emailed_at": "last_30",
  "person_last_name": "Rockefel",
  "person_mobile": "(514) 673",
  "person_modified": "last_30",
  "person_name": "John",
  "person_owner": 145735,
  "person_owner_team": 145735,
  "person_phone": "(514) 673",
  "person_phones": "(514) 673",
  "person_phones_contains": "555-0100",
  "person_position": "VP of",
  "person_relationship": "Manager",
  "person_shared_with": [
    1,
    2,
    3
  ],
  "person_simple_search": "Bell",
  "person_source": 123,
  "person_state": "Dakota",
  "person_status": 82927,
  "person_summary": "Summary",
  "person_tag_names": [
    "tag1",
    "tag2"
  ],
  "person_tags": [
    1,
    2
  ],
  "person_updated_at": "last_30",
  "person_viewed_at": "last_30",
  "person_website": "web.com",
  "person_work_address_1": "123 Fake St.",
  "person_work_address_2": "Suite 101",
  "person_work_zip": "981",
  "person_zip": "64",
  "company_address": "Suite 101.",
  "company_address2": "123 Fake St.",
  "company_city": "Denver",
  "company_country": "United",
  "company_created": "last_30",
  "company_created_at": "last_30",
  "company_created_by_user": 1,
  "company_description": "CRM",
  "company_email": "suppert@pipelinecrm",
  "company_fax": "(514) 897",
  "company_id": 111112113,
  "company_id_not": 123,
  "company_import_name": "Import 1",
  "company_imported_at": "last_30",
  "company_is_customer": "Yes",
  "company_modified": "last_30",
  "company_name": "Pipeline",
  "company_name_eq": "Pipeline",
  "company_owner": 1,
  "company_owner_team": 1,
  "company_phone": "(514) 673",
  "company_phones_contains": "555-0100",
  "company_shared_with": [
    1,
    2,
    3
  ],
  "company_state": "Colorado",
  "company_tags": [
    1,
    2,
    3
  ],
  "company_total_pipeline": {
    "from": 1000,
    "to": 5000
  },
  "company_updated": "last_30",
  "company_updated_at": "last_30",
  "company_web": "pipelinecrm.com",
  "company_won_value": {
    "from": 1000,
    "to": 5000
  },
  "company_worked_on_by": 1,
  "company_zip": "11001",
  "customer_days_in_health": {
    "from": 1000,
    "to": 5000
  },
  "customer_health_score": 1,
  "next_milestone_due": "last_30",
  "next_milestone_status": "in_progress"
}

Response

Successful Response

Example response

{
  "entries": [
    {
      "id": 8802,
      "user": {
        "id": 13,
        "first_name": "Sam",
        "last_name": "Okafor"
      },
      "owner": "Sam Okafor",
      "created_by_user": {
        "id": 13,
        "first_name": "Sam",
        "last_name": "Okafor"
      },
      "company": {
        "id": 3310,
        "name": "Acme Corporation"
      },
      "deals": [
        {
          "id": 4521,
          "name": "Acme renewal"
        }
      ],
      "currency": {
        "id": 1,
        "name": "US Dollar",
        "code": "USD",
        "symbol": "$",
        "decimal_places": 2
      },
      "project_shared_user_ids": [],
      "has_work_address": true,
      "lead_status": {
        "id": 2,
        "name": "Qualified",
        "hex_color": "#4EB571"
      },
      "lead_source": {
        "id": 5,
        "name": "Website"
      },
      "image_mobile_url": "https://s3.amazonaws.com/avatar.png",
      "predefined_contacts_tags": [
        {
          "id": 2,
          "name": "Decision maker"
        }
      ],
      "possible_notify_user_ids": [
        1,
        2,
        3,
        4,
        5
      ],
      "next_entry_name": "Send revised quote",
      "next_entry_id": 5602,
      "next_entry_due": "2026/09/08",
      "created_at": "2026-09-01 14:22:07",
      "updated_at": "2026-09-01 14:22:07",
      "first_name": "Jane",
      "last_name": "Rivera",
      "full_name": "Jane Rivera",
      "summary": "Owns the renewal decision; prefers email.",
      "phone": "+1 415 555 0142",
      "home_phone": "123-123-1234",
      "mobile": "+1 415 555 0177",
      "position": "Head of Operations",
      "website": "http://www.james-smith.com",
      "email": "jane.rivera@acme.example",
      "email2": "james.smith@acme-inc.com",
      "home_email": "james.smith@gmail.com",
      "company_id": 3310,
      "company_name": "Acme Corporation",
      "user_id": 13,
      "lead_status_id": 2,
      "lead_source_id": 5,
      "image_thumb_url": "https://s3.amazonaws.com/avatar.png",
      "predefined_contacts_tag_ids": [
        3,
        4,
        5
      ],
      "work_address_1": "Suite 101",
      "work_address_2": "123 Fake St.",
      "work_city": "Denver",
      "work_state": "Colorado",
      "work_country": "United States",
      "home_address_1": "Suite 101.",
      "home_address_2": "123 Fake St.",
      "home_city": "Denver",
      "home_state": "Colorado",
      "home_country": "United States",
      "facebook_url": "https://www.facebook.com/james.smith",
      "linked_in_url": "https://www.linkedin.com/in/james-smith-101",
      "twitter": "james.smith",
      "instant_message": "james_smith_20",
      "last_emailed_at": "2020-02-07 15:26:10 -0500",
      "custom_fields": {
        "custom_label_90": [
          45,
          46,
          47
        ],
        "custom_label_5": "text val"
      },
      "shared_user_ids": [
        1,
        2,
        3
      ],
      "relationship": "Owner",
      "is_key_contact": true,
      "type": "Contact",
      "deal_ids": [
        4521
      ],
      "created_by_user_id": 13
    }
  ],
  "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.