> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ledgerup.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List accounts.



## OpenAPI

````yaml /openapi/ledgerup-engine.json get /v2/accounts
openapi: 3.1.0
info:
  title: LedgerUp API
  version: 0.1.0
  description: OpenAPI contract for the LedgerUp API.
servers: []
security: []
tags:
  - name: Health
  - name: Customers
  - name: Accounts
  - name: Grants
  - name: Currencies
    description: Currencies discovered from reported usage events.
  - name: Metrics
  - name: Refill Configurations
    description: Automatic balance refill thresholds and targets for an account and metric.
  - name: Events
    description: >-
      Individual usage events reported against an account and either a metric or
      currency.
  - name: Test
    description: Endpoints for test environment maintenance.
  - name: Products
    x-group: Billing
    description: Sellable catalog objects. Products can map to Stripe products.
  - name: Prices
    x-group: Billing
    description: >-
      Simple commercial terms for a product. Contract lines can reference a
      price or a rate card, but not both.
  - name: Rate Cards
    x-group: Billing
    description: Reusable rating policies that convert engine facts into billable amounts.
  - name: Contracts
    x-group: Billing
    description: >-
      Subscription-like commercial agreements. Contracts own contract lines and
      cancellation state.
  - name: Invoice Preview
    x-group: Billing
    description: Read-only preview of LedgerUp invoice lines before any Stripe write.
paths:
  /v2/accounts:
    get:
      tags:
        - Accounts
      summary: List accounts.
      operationId: listAccounts
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            format: int64
            minimum: 1
            maximum: 100
            default: 100
          description: Maximum number of records to return. Defaults to 100.
        - name: starting_after
          in: query
          required: false
          schema:
            type: string
            description: >-
              Return records following this resource id in the selected sort
              order.
          description: Cursor resource id from the previous page.
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - created_at
              - customer_name
            default: created_at
          description: >-
            Sort by newest creation time or case-insensitive customer name then
            account name. Accounts without a customer sort last.
      responses:
        '200':
          description: Page of resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountList'
        '400':
          $ref: '#/components/responses/BadRequestText'
        '401':
          $ref: '#/components/responses/UnauthorizedText'
        '403':
          $ref: '#/components/responses/ForbiddenText'
        '408':
          $ref: '#/components/responses/RequestTimeoutText'
        '429':
          $ref: '#/components/responses/RateLimitedText'
        '500':
          $ref: '#/components/responses/InternalServerErrorText'
      security:
        - LedgerUpApiKey: []
components:
  schemas:
    AccountList:
      type: object
      additionalProperties: false
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Account'
        has_more:
          type: boolean
          description: True when additional records are available after the returned page.
          example: false
      required:
        - data
        - has_more
    Account:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: LedgerUp account identifier.
          example: account_0194f4e3a2b77c6aa91c4f6b4db2a980
          pattern: ^account_[0-9a-f]{32}$
        external_id:
          type:
            - string
            - 'null'
          description: >-
            Optional caller-supplied external identifier. Maximum 256 Unicode
            scalar values.
          maxLength: 256
          example: crm_acme_001
        ledgerup_customer_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Optional LedgerUp billing customer UUID.
          example: 0194f4e3-a2b7-7c6a-a91c-4f6b4db2a980
        name:
          type: string
          description: Human-readable name. Maximum 256 Unicode scalar values.
          maxLength: 256
          example: Acme
        description:
          type:
            - string
            - 'null'
          description: Optional description. Maximum 2048 Unicode scalar values.
          maxLength: 2048
          example: Usage tracked for Acme.
        created_at:
          $ref: '#/components/schemas/UnixTimestamp'
        updated_at:
          $ref: '#/components/schemas/UnixTimestamp'
        archived_at:
          anyOf:
            - $ref: '#/components/schemas/UnixTimestamp'
            - type: 'null'
      required:
        - id
        - external_id
        - ledgerup_customer_id
        - name
        - description
        - created_at
        - updated_at
        - archived_at
    UnixTimestamp:
      type: integer
      format: int64
      description: Unix timestamp in seconds.
      example: 1767225600
  responses:
    BadRequestText:
      description: >-
        Bad request, invalid header, invalid amount/quantity/currency, or text
        validation failure.
      content:
        text/plain:
          schema:
            type: string
    UnauthorizedText:
      description: Missing or invalid API key.
      content:
        text/plain:
          schema:
            type: string
            example: Invalid API key
    ForbiddenText:
      description: >-
        API key lacks the required permission, or reset was attempted outside
        the test namespace.
      content:
        text/plain:
          schema:
            type: string
    RequestTimeoutText:
      description: Request exceeded the 30 second timeout.
      content:
        text/plain:
          schema:
            type: string
    RateLimitedText:
      description: Rate limit exceeded.
      content:
        text/plain:
          schema:
            type: string
            example: rate limit exceeded
    InternalServerErrorText:
      description: Internal server error or queue failure.
      content:
        text/plain:
          schema:
            type: string
  securitySchemes:
    LedgerUpApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: LedgerUp API Key.
      x-displayName: LedgerUp API Key

````