Skip to main content

crm_organization

A company as the CRM knows it: the account the deals hang off. Not to be confused with the Companies resource, which is the contact-directory entity — the two are separate records with separate endpoints.

idinteger
namestring
urlstring

Website

cnpjstring

Brazilian company registration number

legal_namestring

Registered name, when it differs from the trading name

state_registrationstring
phonestring
emailstring
custom_fieldsobject

Values of the account's custom fields. The company's segment lives here, under segment, as the segment's name.

labelsstring[]
contacts_countinteger

Contacts filed under this company

deals_countinteger

Deals of this company, whatever their status

open_valuenumber

Total of the ongoing deals. Only meaningful when they share a currency — read open_values otherwise.

open_values object[]

The open total broken down by currency

  • Array [
  • currencystring
    valuenumber
  • ]
  • owner_idinteger
    owner object

    Present when the company has an owner

    idinteger
    namestring
    created_atinteger
    updated_atinteger
    crm_organization
    {
    "id": 0,
    "name": "string",
    "url": "string",
    "cnpj": "string",
    "legal_name": "string",
    "state_registration": "string",
    "phone": "string",
    "email": "string",
    "custom_fields": {},
    "labels": [
    "string"
    ],
    "contacts_count": 0,
    "deals_count": 0,
    "open_value": 0,
    "open_values": [
    {
    "currency": "string",
    "value": 0
    }
    ],
    "owner_id": 0,
    "owner": {
    "id": 0,
    "name": "string"
    },
    "created_at": 0,
    "updated_at": 0
    }