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

# List Accounts

`GET /v1/accounts`

## Request

- Base URL: `https://api.volteras.com`
- URL: `https://api.volteras.com/v1/accounts`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/v1/oauth2/token`
- TypeScript: <https://skmtc.dev/volteras/apis/volteras-connect/docs/v1/accounts/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a paginated list of active accounts associated with the current organization.

_Find details on list filter syntax in our documentation [here](/overview/listing-filter-json)._


Possible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):

- AUTHENTICATION_ERROR
- PAGE_SIZE_TOO_LARGE
- PAGINATED_QUERY_FILTER_CHANGED
- REQUEST_VALIDATION_ERROR
- SERVER_ERROR

## Query parameters

- `maxPageSize` integer: Max size of the returned list.
- `pageToken` string, nullable: Page token used for pagination.
- `filter` string, nullable: Listing filter schema.

## Response `200`

Successful Response

- PageOEMAccount
  - `results` OEMAccount[], required: Returned data from the listing query.
    - `id` string, required
    - `username` string, required
  - `nextPageToken` string, nullable, required: Next page token used for pagination.
  - `totalResults` integer, required: Total result count.

---

[API](https://skmtc.dev/volteras/apis/volteras-connect.md) - [All operations](https://skmtc.dev/volteras/apis/volteras-connect/llms.txt) - [OpenAPI document](https://skmtc.dev/volteras/apis/volteras-connect/revisions/87f865622b4a?raw)