# List end users
Source: https://www.desktopaccountingapi.com/docs/api/reference/operations/enduserslist/

`GET https://api.desktopaccountingapi.com/v1/end-users`

Operation ID: `endUsers.list`. Tag: End users.

Returns the project's end users, newest first, with cursor pagination.

Authentication: `Authorization: Bearer <secret key>`.

## Query parameters

- `cursor` (string): The `nextCursor` from the previous page. 1–200 characters.
- `limit` (integer): Page size, 1–100. Default 50. 1 to 100; default `50`; example `50`.

## Responses

### 200

A page of end users.

Body (application/json): object (EndUserList).

- `objectType` (string, required): Always `list`. one of `list`.
- `url` (string, required): The endpoint that produced this list. one of `/v1/end-users`.
- `data` (array of object (EndUser), required): Objects on this page, newest first.
  - `id` (string, required): Unique identifier for the end user. example `eu_01j9x4m6v4c8k2t7q0r5s3w1zb`.
  - `objectType` (string, required): Always `end_user`. one of `end_user`.
  - `createdAt` (string (date-time), required): When the end user was created. UTC, ISO 8601 with milliseconds. example `2026-10-05T16:03:59.002Z`.
  - `companyName` (string, required): The end user's company name, shown in the setup flow. example `Acme Supply`.
  - `sourceId` (string, required): Your identifier for this end user. Unique within the project. example `cust_8812`.
  - `email` (string, required): Contact email, for your identification only. We never email end users. example `ops@acme.example`.
  - `integrationConnections` (array of object (IntegrationConnection), required): QuickBooks Desktop connections. Empty until the first auth session is created; at most one in v1.
    - `id` (string, required): Unique identifier for the connection. example `conn_01j9x4m6v4c8k2t7q0r5s3w1zc`.
    - `objectType` (string, required): Always `integration_connection`. one of `integration_connection`.
    - `createdAt` (string (date-time), required): When the connection was created. UTC, ISO 8601 with milliseconds. example `2026-10-05T16:03:59.002Z`.
    - `integrationSlug` (string, required): The integration this connection uses. one of `quickbooks_desktop`.
    - `status` (string, required): Derived connection status. `pending_setup`: no Web Connector has finished setup. `online`: the Web Connector checked in recently and the last QuickBooks session opened. `quickbooks_unavailable`: the Web Connector checks in but QuickBooks could not be opened (`statusReason` holds the error code). `company_file_mismatch`: a different company file is open. `offline`: no recent check-in. `disabled`: turned off by the developer. one of `pending_setup`, `online`, `quickbooks_unavailable`, `company_file_mismatch`, `offline`, `disabled` (open: accept unknown values).
    - `statusReason` (string, nullable, required): Code explaining a non-online status, when known: an error code (for example `QBD_ACCESS_NOT_GRANTED`), `QBD_QUICKBOOKS_NOT_RESPONDING` (the Web Connector checks in but QuickBooks does not answer, usually because a dialog is open) or `WEB_CONNECTOR_SCHEDULE_CHANGED`. example `QBD_QUICKBOOKS_NOT_RESPONDING`.
    - `lastRequestAt` (string, nullable, required): When the last request for this connection was made. UTC, ISO 8601.
    - `lastSuccessfulRequestAt` (string, nullable, required): When the last request succeeded. UTC, ISO 8601.
    - `lastHeartbeatAt` (string, nullable, required): When the Web Connector last checked in. UTC, ISO 8601.
    - `companyFile` (object, nullable, required): The connected company file, once a session has opened.
- `nextCursor` (string, nullable, required): Pass as `cursor` to fetch the next page; `null` on the last page.
- `hasMore` (boolean, required): Whether another page exists.
- `remainingCount` (integer, nullable, required): Always `null` for platform lists.
- `cursorExpiresAt` (string, nullable, required): Always `null`: platform cursors do not expire.

### Errors

Every error body is the error object described at https://www.desktopaccountingapi.com/docs/errors/.

- `400`: The request is invalid. Codes: `UNKNOWN_HEADER`, `INVALID_PARAMETER`, `CURSOR_INVALID`.
- `401`: The API key is missing or invalid. Codes: `API_KEY_MISSING`, `API_KEY_INVALID`.
- `429`: Too many requests. Codes: `RATE_LIMITED`.
- `500`: Unexpected server error. Codes: `INTERNAL_ERROR`.
- `503`: QuickBooks Desktop or the service is not available. Codes: `SERVICE_UNAVAILABLE`.