---
title: "List accounts"
method: GET
path: "/accounts"
tags: ["Accounts"]
---

# List accounts

`GET /accounts`

## Request

- Base URL: `https://api-staging.fanheroapi.com`
- URL: `https://api-staging.fanheroapi.com/accounts`
- Auth: API key in header `apiKey`

## Query parameters

- `pageSize` number
- `page` number
- `sortBy` string
- `tenant_id` string
- `email__exact` string
- `username__exact` string
- `username__contains` string
- `first_name__exact` string
- `first_name__contains` string
- `last_name__exact` string
- `last_name__contains` string
- `is_admin` boolean
- `active` boolean, nullable
- `block_temp` string, date-time, nullable
- `block_perm` boolean, nullable
- `pending_activation` boolean, nullable
- `gdpr` boolean, nullable
- `term` string

## Headers

- `organization` string, required

## Response `200`

Successful resopnse

- object: A paginated list of Account objects
  - `page` integer: The current page
  - `pageSize` integer: The number of objects per page
  - `total` integer: The total number of objects in the response
  - `pageCount` integer: The total number of pages
  - `pageNumberIsGood` boolean: Page number is valid.
  - `hasPreviousPage` boolean: There is a previous page.
  - `hasNextPage` boolean: There is a next page.
  - `isFirstPage` boolean: This is the first page.
  - `isLastPage` boolean: This is the last page.
  - `rows` object[]: **Accounts**
    - `id` string: Account ID
    - `display_name` string: Display Name
    - `username` string: User Name
    - `first_name` string: First Name
    - `last_name` string: Last Name
    - `email` string, email: Email address for the account
    - `status` object: Account status
      - `active` boolean: The account is active.
      - `block_temp` string, date-time: The account is temporarily blocked until this date.
      - `block_perm` boolean: The account is permanently blocked.
      - `pending_activation` boolean: The account is pending activation.
      - `gdpr` boolean: The account has GDPR requirements.
    - `organization` string: Organization ID
    - `is_admin` boolean: Admin account
    - `is_tenant_user` boolean: The account is the owner of the organization
    - `is_super_user` boolean: Super user

---

[API](https://skmtc.dev/fanhero/apis/user-management-endpoints.md) - [All operations](https://skmtc.dev/fanhero/apis/user-management-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/fanhero/apis/user-management-endpoints/revisions/3f982670c057?raw)