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

# List client accounts

> GET /client-accounts

Returns the client accounts the connected user can access, each with its taxpayers, one page at a time.
See the [Transcripts overview](https://docs.taxrock.com/api-reference/transcripts/overview.md).


## OpenAPI

````yaml api-reference/openapi-delegate.json GET /client-accounts
openapi: 3.1.0
info:
  title: TaxRock API (delegate access)
  version: 1.0.0
  description: >-
    The TaxRock API with delegate access: reads what a connected TaxRock user
    can access, after the user consents once. See Getting started.
servers:
  - url: https://delegate-demo.api.taxrock.com
    description: Sandbox
security:
  - bearerAuth: []
paths:
  /client-accounts:
    get:
      tags:
        - Client Accounts
      summary: List client accounts
      description: >-
        Lists the client accounts the connected user can access, each with its
        taxpayers, one page at a time. Requires the `read:client-accounts`
        scope.
      operationId: listClientAccounts
      parameters:
        - name: page
          in: query
          required: false
          description: The page number, from 1.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          description: Client accounts per page.
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
      responses:
        '200':
          description: One page of client accounts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAccountPage'
              example:
                clientAccounts:
                  - id: 00000000-0000-4000-8000-0000000000c1
                    name: Example Family
                    taxpayers:
                      - id: 00000000-0000-4000-8000-0000000000a1
                        name: Example Holdings LLC
                        type: Business
                        tin: '000000000'
                      - id: 00000000-0000-4000-8000-0000000000a2
                        name: Taylor Example
                        type: Individual
                        tin: '000000000'
                  - id: 00000000-0000-4000-8000-0000000000c2
                    name: Example Holdings
                    taxpayers:
                      - id: 00000000-0000-4000-8000-0000000000a1
                        name: Example Holdings LLC
                        type: Business
                        tin: '000000000'
                page: 1
                pageSize: 100
                totalCount: 2
                hasNextPage: false
        '400':
          description: >-
            `page` or `pageSize` is not an integer. `error` is
            `invalid_request`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                invalidRequest:
                  summary: Malformed value
                  value:
                    error: invalid_request
                    message: The value 'abc' is not valid.
        '401':
          description: >-
            Missing or invalid access token. Refresh the token, or send the user
            back through the authorization flow.
        '403':
          description: >-
            `error` is `insufficient_scope` when the token lacks the
            `read:client-accounts` scope, or `forbidden` when the connected user
            is not eligible or lacks permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                insufficientScope:
                  summary: Token missing the required scope
                  value:
                    error: insufficient_scope
                    message: >-
                      Access token is missing the required scope. Re-run
                      authorize requesting: read:client-accounts.
                forbidden:
                  summary: User not eligible or not permitted
                  value:
                    error: forbidden
                    message: Caller lacks the required permission.
components:
  schemas:
    ClientAccountPage:
      type: object
      required:
        - clientAccounts
        - page
        - pageSize
        - totalCount
        - hasNextPage
      properties:
        clientAccounts:
          type: array
          items:
            $ref: '#/components/schemas/ClientAccount'
          description: The page's client accounts.
        page:
          type: integer
          description: The page number.
        pageSize:
          type: integer
          description: The page size.
        totalCount:
          type: integer
          description: Client accounts across all pages.
        hasNextPage:
          type: boolean
          description: Whether another page follows.
    ApiError:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: Machine-readable error code, e.g. `invalid_request` or `forbidden`.
        message:
          type: string
          description: Human-readable explanation.
    ClientAccount:
      type: object
      description: A client account with its taxpayers.
      required:
        - id
        - name
        - taxpayers
      properties:
        id:
          type: string
          format: uuid
          description: The client account's id.
        name:
          type: string
          description: The client account's name.
        taxpayers:
          type: array
          items:
            $ref: '#/components/schemas/TaxpayerListItem'
          description: The client account's taxpayers, as List taxpayers returns them.
    TaxpayerListItem:
      type: object
      required:
        - id
        - name
        - type
        - tin
      properties:
        id:
          type: string
          format: uuid
          description: The taxpayer's id.
        name:
          type: string
          description: The business name, or an individual's first and last name.
        type:
          $ref: '#/components/schemas/TaxpayerType'
        tin:
          type: string
          description: The taxpayer's TIN.
    TaxpayerType:
      type: string
      enum:
        - Business
        - Individual
      description: Whether the taxpayer is a business (EIN) or an individual (SSN).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The access token obtained from the OAuth flow, sent as a Bearer
        credential.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.