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

# List documents

> A client’s documents, newest first: file name, status, the kind of document once read, the date it carries, and how many facts it proposed. Replaced documents are left out.



## OpenAPI

````yaml /openapi/advisor.json get /clients/{client}/documents
openapi: 3.1.0
info:
  title: Redbark Advisor API
  version: 2.0.0
  description: >-
    Read and write access to one advice firm in Redbark Advisor: clients,
    checklists, documents, money, messages, reports, team and webhooks. Send an
    API key or a connected app’s access token as a bearer token. A credential
    carries scopes, one read and one write per area, and each call says the
    scope it needs. A write scope brings its read scope. Each key may make 120
    requests a minute.
servers:
  - url: https://advisor.redbark.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Firm
    description: The firm, its name and its branding.
  - name: Team
    description: Team members and their roles.
  - name: Clients
    description: Clients, their people and portal invites.
  - name: Checklists
    description: Checklist templates, the checklists sent to clients and their answers.
  - name: Documents
    description: Documents clients upload and the details read from them.
  - name: Money
    description: Bank connections, accounts, balances and transactions.
  - name: Document types
    description: Document types, their fields and the client facts they fill.
  - name: Messages
    description: Messages between the firm and clients.
  - name: Reports
    description: Reports exported for clients.
  - name: Webhooks
    description: Webhook endpoints and their deliveries.
  - name: Webhook events
    description: Events sent to your webhook endpoints.
paths:
  /clients/{client}/documents:
    get:
      tags:
        - Documents
      summary: List documents
      description: >-
        A client’s documents, newest first: file name, status, the kind of
        document once read, the date it carries, and how many facts it proposed.
        Replaced documents are left out.
      operationId: list_documents
      parameters:
        - name: client
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: The client id, from list_clients.
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 1
                maximum: 100
                description: 1 to 100. Default 25.
              - type: 'null'
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 400
                description: The next_cursor of the previous page.
              - type: 'null'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentList'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key or access token is missing, wrong, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            subscription_required: the firm has no active subscription, so it
            cannot add or invite clients or send checklists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The credential lacks the scope this call needs, the call is for
            admins only, or the member it acts as has left the firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The resource is in a state that does not allow this, such as an
            archived client, or client_limit_reached: the plan’s 20 active
            clients are in use.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The request body is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests. See the Retry-After header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Something went wrong on our side. Try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - documents:read
components:
  schemas:
    DocumentList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Document'
        has_more:
          type: boolean
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
        next_page_url:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - object
        - data
        - has_more
        - next_cursor
        - next_page_url
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              anyOf:
                - type: string
                - type: 'null'
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - param
            - request_id
          additionalProperties: true
      required:
        - error
      additionalProperties: true
    Document:
      type: object
      properties:
        object:
          type: string
          enum:
            - document
        id:
          type: string
        file_name:
          type: string
        mime_type:
          type: string
        size_bytes:
          type: number
        status:
          type: string
          enum:
            - uploaded
            - reading
            - read
            - unreadable
            - replaced
          description: >-
            uploaded (waiting to be read), reading, read, unreadable, or
            replaced by a newer upload.
        doc_type:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The kind of document, such as super_statement or payslip. Null until
            read.
        doc_type_label:
          anyOf:
            - type: string
            - type: 'null'
        statement_date:
          anyOf:
            - type: string
            - type: 'null'
          description: The date the document carries, YYYY-MM-DD.
        page_count:
          anyOf:
            - type: number
            - type: 'null'
        failure:
          anyOf:
            - type: string
            - type: 'null'
          description: Why it could not be read, in words for the client.
        uploaded_by:
          anyOf:
            - type: object
              properties:
                kind:
                  type: string
                  enum:
                    - person
                    - member
                id:
                  type: string
                name:
                  anyOf:
                    - type: string
                    - type: 'null'
              required:
                - kind
                - id
                - name
              additionalProperties: true
            - type: 'null'
        checklist_item_id:
          anyOf:
            - type: string
            - type: 'null'
        replaced_by_id:
          anyOf:
            - type: string
            - type: 'null'
        facts_proposed:
          type: number
        facts_accepted:
          type: number
        review_status:
          type: string
          enum:
            - reading
            - to_review
            - choose_type
            - couldnt_read
            - approved
            - filed
            - sent_back
          description: >-
            Where the firm’s review stands: reading, to_review (values wait for
            approval), choose_type (we could not tell what it is), couldnt_read,
            approved, filed (kept as a file only) or sent_back.
        values_read:
          type: number
          description: How many values were read from it.
        values_to_review:
          type: number
          description: Values waiting for approval.
        values_to_check:
          type: number
          description: >-
            Values waiting that were read with low confidence and are checked
            first.
        created_at:
          type: string
          description: An ISO 8601 time in UTC.
        read_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        reviewed_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
      required:
        - object
        - id
        - file_name
        - mime_type
        - size_bytes
        - status
        - doc_type
        - doc_type_label
        - statement_date
        - page_count
        - failure
        - uploaded_by
        - checklist_item_id
        - replaced_by_id
        - facts_proposed
        - facts_accepted
        - review_status
        - values_read
        - values_to_review
        - values_to_check
        - created_at
        - read_at
        - reviewed_at
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A firm API key, shown once when it is made, or a connected app’s OAuth
        access token. Each operation lists the scope it needs, such as
        clients:write.

````

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