---
title: "List end-user accounts"
method: GET
path: "/v2/{tenant_slug}/enduseraccounts"
tags: ["End User Accounts"]
---

# List end-user accounts

`GET /v2/{tenant_slug}/enduseraccounts`

## Request

- Base URL: `https://api.demo-retail.urbanfox.io`
- URL: `https://api.demo-retail.urbanfox.io/v2/{tenant_slug}/enduseraccounts`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.demo-retail.urbanfox.io/v2/oauth/token` scopes: `read:enduseraccounts`
- TypeScript: <https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/docs/v2/:tenant_slug/enduseraccounts/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `tenant_slug` string, required: Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

## Query parameters

- `is_blocked` boolean, nullable: Filter end-user accounts by whether they are blocked from accessing services.

## Response `200`

Successful Response

- APIResponseEndUserAccountListResponse
  - `data` EndUserAccountListResponse, required
    - `end_user_accounts` EndUserAccountListItemResponse[], required: List of end user accounts for the client
      - `tenant_id` string, uuid, required: Identifier of the tenant that owns this account
      - `website_account_id` string, required: Identifier of the end user's website account
      - `crm_account_id` string, nullable: Optional identifier linking this account to a record in the tenant's CRM system
      - `is_blocked` boolean, required: True when the account is blocked from accessing services
      - `is_quarantined` boolean: True when the account is quarantined pending manual review
      - `is_fraudulent` boolean: True when the account has been confirmed as fraudulent
      - `last_session_updated_on` string, date-time, nullable: Time the most recent session for this account was updated (RFC 3339 / ISO 8601 UTC)

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Request Validation Failed
- `500`: Internal Server Error

---

[API](https://skmtc.dev/urbanfox/apis/urbanfox-customer-api.md) - [All operations](https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/revisions/2850fb315db8?raw)