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

# List accounts

`GET /v1/accounts`

## Request

- Base URL: `https://api.octolane.com`
- URL: `https://api.octolane.com/v1/accounts`
- Auth: API key in header `x-api-key`

Returns accounts using cursor pagination with optional search and field projection. Custom attribute names and value types are returned in `data.custom_field_definitions`; keys in that map match keys under each account's `custom_fields` object.

## Query parameters

- `q` string
- `cursor` string
- `limit` integer
- `fields` union
  - string
  - string[]

## Response `200`

Accounts were returned.

- object
  - `success` boolean
  - `message` string
  - `data` object: Endpoint-specific response payload.
    - `custom_field_definitions` CustomFieldDefinitions, required: Map of custom field slug to definition. This is returned by `/v1/accounts`, `/v1/accounts/search`, `/v1/contacts`, `/v1/contacts/search`, `/v1/opportunities`, and `/v1/opportunities/search`. The map key matches the key used under each record's `custom_fields` object. If the request uses `fields`, only selected custom fields are included; otherwise all visible custom fields for the object are included. For opportunities, definitions are scoped to the requested `pipeline_id`.
    - `has_more` boolean, required: Whether another page is available.
    - `next_cursor` string, nullable, required: Cursor to pass on the next request when `has_more` is true.
    - `limit` integer, required: Effective page size used for this response.
    - `accounts` AccountRecord[], required
      - `id` string, uuid
      - `name` string, nullable
      - `domain` string, nullable
      - `custom_fields` RecordCustomFields: Custom field values keyed by custom field slug. Use the sibling `custom_field_definitions` map in the same response to get each custom field's display name (`current_name`), stable property name (`property_name`), and value type (`attribute_type`).

## Other responses

- `400`: The request failed validation.
- `401`: The API key is missing, invalid, or not allowed to access this route.
- `429`: The route rate limit was exceeded.

## Changes

- **2026-06-16** `9647d7c49947`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/octolane-org/apis/octolane-public-api/changes/v1/accounts/get.md)

---

[API](https://skmtc.dev/octolane-org/apis/octolane-public-api.md) - [All operations](https://skmtc.dev/octolane-org/apis/octolane-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octolane-org/apis/octolane-public-api/revisions/d248d0a2be5d?raw)