Search user profiles - Zeotap docs

curl --request POST \ --url https://api.zeotap.com/cdp/v1/users/_search \ --header 'Content-Type: application/json' \ --header 'apikey: <api-key>' \ --header 'scopes: <scopes>' \ --data ' { "orgId": 1577, "regions": [ "UK" ], "search": { "icoms_account_uid": [ "amit_170921" ] } } '

[ { "updated_ts": 1662374042063, "created_ts": 1637240279015, "profile": { "Audience": { "CONTROL_FLAG": 0, "AUDIENCE_RUN_DATE": "1660780800000000", "AUDIENCE_SLOT_3": "CA0045_D001", "AUDIENCE_SLOT_4": "NO AUDIENCE", "_ts": "1660832360482" } }, "ids": { "icoms_account_uid": [ { "icoms_account_uid": "41063074106", "_ts": "1639918545133" } ], "linkedUcid": [ "a1a62720-8788-8788-8788-fb81f77515b1" ] }, "mkt_preferences": {}, "consent": {}, "region": "UK", "ucid": "00000000-9295-9295-9295-8db6a1c8e06a" } ]

Authorizations

apikey

string

header

required

Long-lasting client key

Headers

scopes

string

required

Comma-separated list of granted scopes. Allowed values: profile.read, profile.write, profile.delete

Example:

"profile.read,profile.write,profile.delete"

orgId

integer

Zeotap organisation ID. Required when using Okta JWT authentication.

Example:

1577

Body

application/json

orgId

integer

required

Organisation identifier

Example:

1577

regions

string[]

required

Region codes to scope the query

Example:

["UK"]

object

required

Key-value pairs where the key is an identifier type (e.g. icoms_account_uid, email, cellphone) and the value is an array of identifier values to match.

Show child attributes

Example:

{ "icoms_account_uid": ["amit_170921"] }

Response

Matching profiles returned

updated_ts

integer<int64>

Last-updated epoch timestamp (ms)

created_ts

integer<int64>

Created epoch timestamp (ms)

profile

object

Nested profile attributes organised by category (e.g. Audience, demographics). Structure varies by org config.

ids

object

Map of identity namespaces to arrays of identity records. Each namespace (e.g. email, cellphone, ga_clientid) contains an array of identity objects with a timestamp.

Show child attributes

Example:

{
  "email": [
    {
      "email_sha256_lowercase": "af2bdbe...",
      "_ts": "1639918545133"
    }
  ],
  "icoms_account_uid": [
    {
      "icoms_account_uid": "41063074106",
      "_ts": "1639918545133"
    }
  ],
  "linkedUcid": ["a1a62720-8788-8788-8788-fb81f77515b1"]
}

mkt_preferences

object

Marketing opt-in / opt-out preferences

Show child attributes

Consent records

region

string

Region the profile belongs to

Example:

"UK"

ucid

string<uuid>

Unified Customer ID

Example:

"00000000-9295-9295-9295-8db6a1c8e06a"