Skip to main content

company_contact

additional_attributes object

The object containing additional attributes related to the contact

citystring

City of the contact

countrystring

Country of the contact

country_codestring | nullnullable

Country code of the contact

created_at_ipstring

IP address when the contact was created

availability_statusstring

Availability status of the contact

Possible values: [online, offline]

emailstring | nullnullable

The email address of the contact

idinteger

The ID of the contact

namestring

The name of the contact

phone_numberstring | nullnullable

The phone number of the contact

blockedboolean

Whether the contact is blocked

identifierstring | nullnullable

The identifier of the contact

thumbnailstring

The thumbnail of the contact

custom_attributesobject

The custom attributes of the contact

last_activity_atinteger | nullnullable

Timestamp of last activity

created_atinteger

Timestamp when contact was created

contact_inboxes object[]

List of inboxes associated with this contact

  • Array [
    • source_idstring

    Source identifier for the contact inbox

    inbox object
    idinteger

    ID of the inbox

    avatar_urlstring

    URL for the inbox avatar

    channel_idinteger

    ID of the channel

    namestring

    Name of the inbox

    channel_typestring

    Type of channel

    providerstring | nullnullable

    Provider of the inbox

  • ]
    • company_idinteger

    The company the contact is filed under. Null when it is filed nowhere.

    linked_to_current_companyboolean

    Whether this contact belongs to the company in the URL. Always true in the list; in the search it is what separates a contact you can file from one already filed elsewhere.

    company object

    The company the contact currently belongs to, or null

    oneOf

    A company in the contact directory: what contacts are filed under, with a primary contact and an avatar. Separate from CRM Organizations, which is the entity deals hang off — the two are different records with different endpoints.

    Gated by the companies feature; every endpoint answers 403 when the account does not have it.

    idinteger
    namestring
    domainstring

    Website domain, also matched by the search

    descriptionstring
    contacts_countinteger

    Contacts filed under this company

    cnpjstring
    legal_namestring
    state_registrationstring
    phonestring
    emailstring
    responsiblestring

    Free-text name of who to talk to. Not a user reference.

    primary_contact_idinteger
    primary_contact object

    Present when a primary contact is set and still exists

    idinteger
    namestring
    custom_attributesobject
    avatar_urlstring
    last_activity_atinteger

    Unix timestamp of the last activity on the company

    created_atinteger
    updated_atinteger
    company_contact
    {
      "additional_attributes": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "created_at_ip": "string"
      },
      "availability_status": "online",
      "email": "string",
      "id": 0,
      "name": "string",
      "phone_number": "string",
      "blocked": true,
      "identifier": "string",
      "thumbnail": "string",
      "custom_attributes": {},
      "last_activity_at": 0,
      "created_at": 0,
      "contact_inboxes": [
        {
          "source_id": "string",
          "inbox": {
            "id": 0,
            "avatar_url": "string",
            "channel_id": 0,
            "name": "string",
            "channel_type": "string",
            "provider": "string"
          }
        }
      ],
      "company_id": 0,
      "linked_to_current_company": true,
      "company": {
        "id": 0,
        "name": "string",
        "domain": "string",
        "description": "string",
        "contacts_count": 0,
        "cnpj": "string",
        "legal_name": "string",
        "state_registration": "string",
        "phone": "string",
        "email": "string",
        "responsible": "string",
        "primary_contact_id": 0,
        "primary_contact": {
          "id": 0,
          "name": "string"
        },
        "custom_attributes": {},
        "avatar_url": "string",
        "last_activity_at": 0,
        "created_at": 0,
        "updated_at": 0
      }
    }