End User Accounts

List end-user accounts

List end-user accounts for a tenant, optionally filtered by block status.

get/v2/{tenant_slug}/enduseraccounts

Path parameters

tenant_slugstring required

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Example:demo-retail

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Query parameters

is_blockedboolean nullable

Filter end-user accounts by whether they are blocked from accessing services.

Response

Successful Response

Example response

{
  "data": {
    "end_user_accounts": [
      {
        "crm_account_id": "crm-abc456",
        "is_blocked": false,
        "is_fraudulent": false,
        "is_quarantined": false,
        "last_session_updated_on": "2024-01-15T10:30:00Z",
        "tenant_id": "00000000-0000-4000-8000-000000000000",
        "website_account_id": "account-abc123"
      }
    ]
  }
}