Companies

Retrieve company

Retrieve a single company or retrieve associations for a company (notes, people, deals, calendar_entries):

  • GET /api/v3/companies/1234/notes.json
  • GET /api/v3/companies/1234/people.json
  • GET /api/v3/companies/1234/deals.json
  • GET /api/v3/companies/1234/calendar_entries.json
get/companies/{id}

Request

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

Path parameters

idinteger required

Company ID

Response

Successful Response

idinteger

Unique identifier

image_mobile_urlstring

The uploaded mobile avatar of the company. Mobile avatar is scaled to maximum of 100x100 pixels.

possible_notify_user_idsinteger[]

The list of User IDs that can be added to notify_user_ids on associated notes.

next_task_namestring

Name of the next calendar entry due associated with the company

next_task_idinteger

The ID of the next calendar entry due associated with the company

next_task_duestring

Due date of the next calendar entry due associated with the company

next_task_all_dayboolean

Is the next calendar entry due associated with the company an all day event?

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

namestring

The name of the company

descriptionstring nullable
emailstring nullable

The email of the company

webstring nullable

The company's website

faxstring nullable
custom_fieldsobject

Custom fields for the company. See custom fields section for more info.

image_thumb_urlstring

The uploaded avatar of the company. Avatar is scaled to maximum of 50x50 pixels.

address_1string nullable

First line of business address.

address_2string nullable

Second line of business address.

citystring nullable

Business address city.

statestring nullable

Business address state.

postal_codestring nullable

Business address postal code.

countrystring nullable

Business address country.

company_countrystring

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

facebook_urlstring nullable

URL to company's facebook profile

linked_in_urlstring nullable

URL to company's LinkedIn profile

twitterstring nullable

Company's twitter username

instant_messagestring nullable

Company's IM username

phone1string nullable

Primary business number

phone2string nullable

Secondary business number

phone3string nullable

Extra business number

phone4string nullable

Extra business number

phone1_descstring nullable

Description for the primary business number

phone2_descstring nullable

Description for the secondary business number

phone3_descstring nullable

Description for an extra business number

phone4_descstring nullable

Description for an extra business number

owner_idinteger nullable

The ID of the owner of the company

shared_user_idsinteger[]

The array of User IDs with whom this company's been shared (also known as Collaborators)

tag_idsinteger[]

IDs of the tags to set on this company

Example response

{
  "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
  ]
}

Changes

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