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

# List Accounts

> Lists all accounts in your organization with pagination support.

Returns a paginated list of all accounts, sorted by creation date (newest first).
Use this to display account overviews, build account selectors, or audit your
account structure. Results include both active and inactive accounts.



## OpenAPI

````yaml GET /v1/accounts
openapi: 3.1.0
info:
  title: Payment Platform API
  version: 0.0.0
servers: []
security: []
tags:
  - name: Accounts
  - name: Payouts
  - name: Payments
paths:
  /v1/accounts:
    get:
      tags:
        - Accounts
      summary: List Accounts
      description: >-
        Lists all accounts in your organization with pagination support.


        Returns a paginated list of all accounts, sorted by creation date
        (newest first).

        Use this to display account overviews, build account selectors, or audit
        your

        account structure. Results include both active and inactive accounts.
      operationId: Accounts_listAccounts
      parameters:
        - $ref: '#/components/parameters/PaginationQuery.cursor'
        - $ref: '#/components/parameters/PaginationQuery.limit'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - page_size
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Account'
                    description: The array of data items
                  next_cursor:
                    type: string
                    description: >-
                      The cursor pointing to the start of the next page (null if
                      no more pages)
                  page_size:
                    type: integer
                    format: int32
                    description: The number of items returned in this response
                description: Container model for paginated responses
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  parameters:
    PaginationQuery.cursor:
      name: cursor
      in: query
      required: false
      description: >-
        The cursor pointing to the start of the next page (omit for first
        request)
      schema:
        type: string
      explode: false
    PaginationQuery.limit:
      name: limit
      in: query
      required: false
      description: 'The number of items to return per page (default: 25, max: 100)'
      schema:
        type: integer
        format: int32
        default: 25
      explode: false
  schemas:
    Account:
      type: object
      required:
        - accountId
        - name
        - purpose
        - classification
        - status
        - updatedAt
        - createdAt
      properties:
        accountId:
          type: string
          description: Unique identifier for the account
          readOnly: true
        name:
          type: string
          description: Display name for the account
        description:
          type: string
          description: Detailed description of the account's purpose
        purpose:
          allOf:
            - $ref: '#/components/schemas/AccountPurpose'
          description: The purpose of the account
        classification:
          allOf:
            - $ref: '#/components/schemas/AccountClassification'
          description: >-
            Classification that determines the account's priority and usage
            patterns
        status:
          allOf:
            - $ref: '#/components/schemas/AccountStatus'
          description: Current operational status of the account
          readOnly: true
        metadata:
          type: object
          unevaluatedProperties:
            type: string
          description: Additional custom data associated with the account
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the account was created
          readOnly: true
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the account was last updated
          readOnly: true
      description: |-
        Represents a financial account in the system
        Accounts are used to track balances and process transactions
      examples:
        - accountId: acc_12345
          name: Primary Business Account
          description: Main account for business operations
          purpose: OPERATING
          classification: PRIMARY
          status: ACTIVE
          metadata:
            department: finance
            costCenter: HQ
          updatedAt: '2025-04-29T13:29:15.064Z'
          createdAt: '2025-04-29T13:29:15.064Z'
    ApiError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type: string
      description: Standard error structure
    AccountPurpose:
      type: string
      enum:
        - OPERATING
        - WALLET
        - REVENUE
        - TAX
        - RESERVE
        - OTHER
      description: >-
        Defines the primary purpose or category assigned by an SME to an
        account,

        facilitating the organization and management of funds within their
        treasury operations.

        From the perspective of Bluerails (the treasury solution provider), all
        these accounts

        represent liabilities.
    AccountClassification:
      type: string
      enum:
        - PRIMARY
        - SECONDARY
      description: |-
        Allowed classifications for an account
        Determines the account's priority and usage patterns
    AccountStatus:
      type: string
      enum:
        - ACTIVE
        - INACTIVE
      description: |-
        The status of the account
        Indicates whether the account can be used for transactions

````