Get a user
Returns a single user, looked up by external_id when called with a project-scoped key, or by numeric ID when called from the admin scope. Custom-attribute fields not approved for the caller’s role are filtered out.
Authorizations
Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.
Path Parameters
Numeric ID (admin scope) or user external_id (project scope) — the route resolves both.
"cust-9f4b21"
Response
The requested user.
A customer record being marketed to. Owned by a project; identified by external_id.
Numeric identifier. Use external_id as the stable cross-system reference.
1024
Identifier of the project this user belongs to.
42
Stable identifier supplied by the calling system. Treated as the user’s primary key for upserts.
"cust-9f4b21"
Time the user was first created. ISO 8601.
"2026-04-28T05:14:00.000Z"
Time the user was last modified. ISO 8601.
"2026-04-28T05:14:00.000Z"
Anonymous tracking identifier captured before the user was identified, when available.
"anon-2c8a3e"
User’s email address. Format-validated on write.
"jane@example.com"
User’s phone number in E.164 format on read.
"+61400123456"
IANA timezone used for time-of-day delivery scheduling.
"Australia/Sydney"
BCP-47 locale used for content rendering.
"en-AU"
Free-form custom attributes attached to the user. Used in segmentation and template rendering.
True when the user has at least one registered push device.
Registered push devices, when included.