v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB
crm/companies

List Companies

get/crm/companies

Query parameters

remote_databoolean

Set to true to include data from the original software.

limitnumber

Set to get the number of records.

cursorstring

Set to get the number of records after this cursor.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required
next_cursorstring nullable required

Example response

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