Get contact

GET 
/contacts/:contact_id

note

This feature is only available in Preview to select customers on our Enterprise plan. Contact us for more information.

Returns a Contact object with the given id.

Request

Path Parameters

contact_id stringrequired
Example: 0258cbc6-6020-430a-848e-aafacbadf4ae

Query Parameters

include_raw_data boolean
Whether to include raw data fetched from the 3rd party provider.
Example: true

Header Parameters

x-customer-id stringrequired
The customer ID that uniquely identifies the customer in your application
Example: my-customer-1
x-provider-name stringrequired
The provider name
Example: salesforce

Responses

200

ContactData

application/json

Schema

Schema

name stringnullablerequired
email_address stringrequired
phone_number stringnullable
details stringnullable
account stringnullable

Example (from schema)

{
  "name": "Cousin Greg",
  "email_address": "greg@waystar-royco.com",
  "phone_number": "5108890293",
  "details": "Executive Assistant to Tom Wambsgans",
  "account": "8998e1ed-1c76-4b64-9097-9d37ee88bf6f"
}

Loading...