v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB

crm/companies

Retrieve Companies

Retrieve Companies from any connected Crm software

get/crm/companies/{id}

Path parameters

idstring required

id of the company you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Crm software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable required

The name of the company

industrystring nullable

The industry of the company. Authorized values can be found in the Industry enum.

number_of_employeesnumber nullable

The number of employees of the company

user_idstring nullable

The UUID of the user who owns the company

field_mappingsobject nullable

The custom field mappings of the company between the remote 3rd party & Panora

idstring nullable

The UUID of the company

remote_idstring nullable

The id of the company in the context of the Crm 3rd Party

remote_dataobject nullable

The remote data of the company in the context of the Crm 3rd Party

created_atobject nullable

The created date of the object

modified_atobject nullable

The modified date of the object

Example response

{
  "name": "Acme",
  "industry": "ACCOUNTING",
  "number_of_employees": 10,
  "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "email_addresses": [
    {
      "email_address": "acme@gmail.com",
      "email_address_type": "WORK"
    }
  ],
  "addresses": [
    {
      "street_1": "5th Avenue",
      "city": "New York",
      "state": "NY",
      "country": "USA",
      "address_type": "WORK"
    }
  ],
  "phone_numbers": [
    {
      "phone_number": "+33660606067",
      "phone_type": "WORK"
    }
  ],
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  }
}