The user profile object

⚠️

Preview — this feature is being built; the design below is the spec.

The user_profile object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "uprof_01JCF5H7K9M1P3R5T7V9",
  "type": "user_profile",
  "external_id": "cust-4821",
  "display_name": "Dana Lee",
  "locale": "en-GB",
  "timezone": "Europe/London",
  "attributes": {
    "plan": "gold",
    "region": "uk-south"
  },
  "memory_scope": "user:cust-4821",
  "session_count": 17,
  "created_at": "2026-10-02T09:00:00Z",
  "updated_at": "2026-11-05T10:00:00Z"
}

Fields

Field	Type	Description
`id`	string	Starts with `uprof_`.
`type`	string	The object type, always `user_profile`.
`external_id`	string	Your own id for the person; unique within the workspace.
`display_name`	string	See the endpoint pages below.
`locale`	string	BCP 47 tag. The agent is told to answer in this language unless the user writes in another.
`timezone`	string	IANA zone. Used for dates in the agent’s context and for deployment schedules that run per user.
`attributes`	object	Up to 50 keys, string, number or boolean values. Visible to the agent as facts about the user.
`memory_scope`	string	The scope used when agents read or write memories about this person.
`session_count`	integer	Sessions started with this profile.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).
`updated_at`	string	When it last changed.

Returned by

user vault

Was this page helpful?