The compliance user object

⚠️

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

The compliance_user 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": "user_01J9Y0A2C4E6G8J0L2N4",
  "type": "compliance_user",
  "email": "dana@example.com",
  "name": "Dana Lee",
  "status": "active",
  "role_ids": [
    "role_01JCT6U8W0Y2A4C6E8G0"
  ],
  "products": [
    "chat",
    "code",
    "api"
  ],
  "joined_at": "2026-02-10T14:00:00Z",
  "removed_at": null
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `compliance_user`.
`email`	string	Email address.
`name`	string	Name shown in the Console and in reports.
`status`	string	Current state; see the values on the endpoint pages.
`role_ids`	array	Nested detail; see the endpoint pages below.
`products`	array	Products the person has used.
`joined_at`	string	See the endpoint pages below.
`removed_at`	string or null	When they left the organization.

Returned by

compliance_export data_residency

Was this page helpful?