v18

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

crm/contacts

Retrieve Contacts

Retrieve Contacts from any connected CRM

get/crm/contacts/{id}

Path parameters

idstring required

id of the contact you want to retrive.

Query parameters

remote_databoolean

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

Headers

x-connection-tokenstring required

The connection token

Response

first_namestring nullable required

The first name of the contact

last_namestring nullable required

The last name of the contact

user_idstring nullable

The UUID of the user who owns the contact

field_mappingsobject nullable

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

idstring nullable

The UUID of the contact

remote_idstring nullable

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

remote_dataobject nullable

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

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "first_name": "John",
  "last_name": "Doe",
  "email_addresses": [
    {
      "email": "john.doe@example.com",
      "type": "WORK"
    }
  ],
  "phone_numbers": [
    {
      "phone": "1234567890",
      "type": "WORK"
    }
  ],
  "addresses": [
    {
      "street": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "country": "USA",
      "type": "WORK"
    }
  ],
  "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "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"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}