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"
}

Changes

Changed in 6 of the 18 revisions of this API.66813

    • removed the MOBILE enum value from the phone_numbers/items/phone_type response property for the response status 200

      response-property-enum-value-removed

    • removed the PERSONAL enum value from the addresses/items/address_type response property for the response status 200

      response-property-enum-value-removed

    • removed the PERSONAL enum value from the email_addresses/items/email_address_type response property for the response status 200

      response-property-enum-value-removed

    • removed the WORK enum value from the addresses/items/address_type response property for the response status 200

      response-property-enum-value-removed

    • removed the WORK enum value from the email_addresses/items/email_address_type response property for the response status 200

      response-property-enum-value-removed

    • removed the WORK enum value from the phone_numbers/items/phone_type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new COMPANY enum value to the email_addresses/items/owner_type response property for the response status 200

      response-property-enum-value-added

    • added the new CONTACT enum value to the email_addresses/items/owner_type response property for the response status 200

      response-property-enum-value-added

    • added the new MOBILE enum value to the phone_numbers/items/phone_type response property for the response status 200

      response-property-enum-value-added

    • added the new PERSONAL enum value to the addresses/items/address_type response property for the response status 200

      response-property-enum-value-added

    • added the new PERSONAL enum value to the email_addresses/items/email_address_type response property for the response status 200

      response-property-enum-value-added

    • added the new WORK enum value to the addresses/items/address_type response property for the response status 200

      response-property-enum-value-added

    • added the new WORK enum value to the email_addresses/items/email_address_type response property for the response status 200

      response-property-enum-value-added

    • added the new WORK enum value to the phone_numbers/items/phone_type response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ca213ae36b7f321See the full diff
    • the response property addresses became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/address_type became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/city became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/country became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/owner_type became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/postal_code became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/state became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/street_1 became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/street_2 became nullable for the status 200

      response-property-became-nullable

    • the response property created_at became nullable for the status 200

      response-property-became-nullable

    • the response property email_addresses became nullable for the status 200

      response-property-became-nullable

    • the response property email_addresses/items/email_address became nullable for the status 200

      response-property-became-nullable

    • the response property email_addresses/items/email_address_type became nullable for the status 200

      response-property-became-nullable

    • the response property email_addresses/items/owner_type became nullable for the status 200

      response-property-became-nullable

    • the response property field_mappings became nullable for the status 200

      response-property-became-nullable

    • the response property first_name became nullable for the status 200

      response-property-became-nullable

    • the response property id became nullable for the status 200

      response-property-became-nullable

    • the response property last_name became nullable for the status 200

      response-property-became-nullable

    • the response property modified_at became nullable for the status 200

      response-property-became-nullable

    • the response property phone_numbers became nullable for the status 200

      response-property-became-nullable

    • the response property phone_numbers/items/owner_type became nullable for the status 200

      response-property-became-nullable

    • the response property phone_numbers/items/phone_number became nullable for the status 200

      response-property-became-nullable

    • the response property phone_numbers/items/phone_type became nullable for the status 200

      response-property-became-nullable

    • the response property remote_data became nullable for the status 200

      response-property-became-nullable

    • the response property remote_id became nullable for the status 200

      response-property-became-nullable

    • the response property user_id became nullable for the status 200

      response-property-became-nullable

    • the response property created_at became optional for the status 200

      response-property-became-optional

    • the response property field_mappings became optional for the status 200

      response-property-became-optional

    • the response property modified_at became optional for the status 200

      response-property-became-optional

    • the response property remote_data became optional for the status 200

      response-property-became-optional

    • the created_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the modified_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the endpoint scheme security bearer was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the created_at response's property type/format changed from string/date-time to object/ for status 200

      response-property-type-changed

    • the modified_at response's property type/format changed from string/date-time to object/ for status 200

      response-property-type-changed

    • the endpoint scheme security bearer was added to the API

      api-security-added

    • the response property created_at became required for the status 200

      response-property-became-required

    • the response property field_mappings became required for the status 200

      response-property-became-required

    • the response property modified_at became required for the status 200

      response-property-became-required

    • the response property remote_data became required for the status 200

      response-property-became-required

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property addresses became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/address_type became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/city became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/country became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/owner_type became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/postal_code became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/state became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/street_1 became nullable for the status 200

      response-property-became-nullable

    • the response property addresses/items/street_2 became nullable for the status 200

      response-property-became-nullable

    • the response property created_at became nullable for the status 200

      response-property-became-nullable

    • the response property email_addresses became nullable for the status 200

      response-property-became-nullable

    • the response property email_addresses/items/email_address became nullable for the status 200

      response-property-became-nullable

    • the response property email_addresses/items/email_address_type became nullable for the status 200

      response-property-became-nullable

    • the response property email_addresses/items/owner_type became nullable for the status 200

      response-property-became-nullable

    • the response property field_mappings became nullable for the status 200

      response-property-became-nullable

    • the response property first_name became nullable for the status 200

      response-property-became-nullable

    • the response property id became nullable for the status 200

      response-property-became-nullable

    • the response property last_name became nullable for the status 200

      response-property-became-nullable

    • the response property modified_at became nullable for the status 200

      response-property-became-nullable

    • the response property phone_numbers became nullable for the status 200

      response-property-became-nullable

    • the response property phone_numbers/items/owner_type became nullable for the status 200

      response-property-became-nullable

    • the response property phone_numbers/items/phone_number became nullable for the status 200

      response-property-became-nullable

    • the response property phone_numbers/items/phone_type became nullable for the status 200

      response-property-became-nullable

    • the response property remote_data became nullable for the status 200

      response-property-became-nullable

    • the response property remote_id became nullable for the status 200

      response-property-became-nullable

    • the response property user_id became nullable for the status 200

      response-property-became-nullable

    • the response property created_at became optional for the status 200

      response-property-became-optional

    • the response property field_mappings became optional for the status 200

      response-property-became-optional

    • the response property modified_at became optional for the status 200

      response-property-became-optional

    • the response property remote_data became optional for the status 200

      response-property-became-optional

    • the created_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the modified_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security bearer was removed from the API

      api-security-removed