Skip to main content
GET
Get profile

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Path Parameters

profileId
string
required
Minimum string length: 1

Response

Default Response

Unified API view of a Profile row, with property data-lineage envelope and segment memberships.

id
string
required
email
string
required

Canonical email identifier from Profile.email (always present).

phone
string | null
required

Optional phone number from Profile.phone. Non-canonical in v1.

sources
string[]
required

Distinct segment_membership source tags for this Profile (e.g. 'form_submission', 'csv_import', 'shopify'). Used as a fallback when the Profile has no property assignments tagged with a source.

properties
object
required
segments
object[]
required
deliverySuppression
object
required
createdAt
string
required

ISO timestamp of when this Profile was created

updatedAt
string
required

ISO timestamp of when this Profile was last updated