Companies

List companies

Filtered request example — Companies named Acme…, owned by user 13, created in the last 30 days:

curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.pipelinecrm.com/api/v3/companies.json?conditions[company_name]=Acme&conditions[company_owner][]=13&conditions[company_created][selection]=last_30&sort=-company_name&per_page=50"
get/companies

Request

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

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[company_name]=Acme&conditions[company_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.

{
  "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": 3310,
      "image_mobile_url": "https://s3.amazonaws.com/avatar.png",
      "possible_notify_user_ids": [
        1,
        2,
        3,
        4,
        5
      ],
      "owner": {
        "id": 13,
        "full_name": "Sam Okafor"
      },
      "next_task_name": "Introductory call",
      "next_task_id": 5602,
      "next_task_due": "2023/03/17",
      "tags": [
        {
          "id": 3,
          "name": "Enterprise"
        },
        {
          "id": 9,
          "name": "Renewal"
        }
      ],
      "created_at": "2026-09-01 14:22:07",
      "updated_at": "2026-09-01 14:22:07",
      "name": "Acme Corporation",
      "email": "hello@acme.example",
      "web": "https://acme.example",
      "fax": "+1 415 555 0199",
      "custom_fields": {
        "custom_label_90": [
          45,
          46,
          47
        ],
        "custom_label_5": "text val"
      },
      "image_thumb_url": "http://s3.amazonaws.com/avatar.png",
      "address_1": "500 Market St",
      "address_2": "123 Fake St.",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94105",
      "country": "USA",
      "company_country": "United States",
      "facebook_url": "https://www.facebook.com/abc.company",
      "linked_in_url": "https://www.linkedin.com/in/abc-company",
      "twitter": "abc-company",
      "instant_message": "abc-company",
      "phone1": "+1 415 555 0100",
      "phone2": "123-123-1234",
      "phone3": "123-123-1234",
      "phone4": "123-123-1234",
      "phone1_desc": "Head Office call line",
      "phone2_desc": "Billing department number",
      "phone3_desc": "Backup line for billing",
      "phone4_desc": "Backup line for billing",
      "owner_id": 13,
      "shared_user_ids": [
        1,
        2,
        3
      ],
      "tag_ids": [
        3,
        4,
        5
      ]
    }
  ],
  "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.