cdp
profile

List all profiles

Changed on
get/cdp/{connection_id}/profile

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/cdp/{connection_id}/profile
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this profile object

created_atstring date-time

The date that this profile object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this profile object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The full name of the profile

first_namestring

The first name of the profile

last_namestring

The last name of the profile

emailstring

The primary email address of the profile

telephonestring

The primary telephone number of the profile

gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'

The gender of the profile

birthdatestring

The birth date of the profile

titlestring

The job title of the profile

companystring

The company/organization name of the profile

is_anonymousboolean

Whether the profile is anonymous (no known identity)

source_idstring

The cdp_source this profile originated from; points to CdpSource

rawobject

The raw data returned by the integration for this profile

Changes