Profiles

Get a user profile (GET)

Changed on

Get a user profile by identity key/value

get/identity/{table}/{key}/{value}

Request

  • Base URL
    https://api.lytics.io/v2
  • URL
    https://api.lytics.io/v2/identity/{table}/{key}/{value}
  • Auth
    API key in header Authorization

Path parameters

tablestring required

The table (e.g. user)

keystring required

Identity Key (e.g. email)

valuestring required

Value (e.g. hello@lytics.com)

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

field_blockliststring[]

Fields to exclude (e.g. email,city)

hash_piiboolean

Return PII/private fields SHA256-hashed instead of plain (only fields the caller may already read; never widens access)

Response

User profile

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Changes