> ## 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 document types

> Every document type the firm reads: Redbark's in picker order, then the firm's own. Each with key, label, description, group, whether it is built in (origin), whether it holds values or a file only, whether it is archived, how many fields it reads, the client facts it fills and how many documents of it were read in the last 30 days. Not paged.



## OpenAPI

````yaml /openapi/advisor.json get /document_types
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:
  /document_types:
    get:
      tags:
        - Document types
      summary: List document types
      description: >-
        Every document type the firm reads: Redbark's in picker order, then the
        firm's own. Each with key, label, description, group, whether it is
        built in (origin), whether it holds values or a file only, whether it is
        archived, how many fields it reads, the client facts it fills and how
        many documents of it were read in the last 30 days. Not paged.
      operationId: list_document_types
      parameters: []
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTypeList'
        '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:
            - document_types:read
components:
  schemas:
    DocumentTypeList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/DocumentTypeSummary'
        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
    DocumentTypeSummary:
      type: object
      properties:
        object:
          type: string
          enum:
            - document_type
        id:
          anyOf:
            - type: string
            - type: 'null'
          description: Null for a built-in type.
        key:
          type: string
          description: >-
            Such as payslip or super_statement, or firm_ and a slug for the
            firm's own.
        label:
          type: string
        description:
          type: string
        group:
          type: string
          enum:
            - banking
            - income
            - investments
            - property
            - structure
            - other
          description: >-
            The heading it is picked under: banking (Banking and loans), income
            (Income and tax), investments (Investments and super), property
            (Property and insurance), structure (Entities and structure), other
            (Other).
        origin:
          type: string
          enum:
            - redbark
            - firm
          description: >-
            redbark for Redbark's own, which cannot be changed; firm for the
            firm's own.
        holds:
          type: string
          enum:
            - values
            - file
          description: >-
            values: values on the page are read into its fields. file: kept as a
            file, nothing read. Fixed once made.
        archived:
          type: boolean
          description: >-
            A firm type no longer sorted into or offered. Documents already read
            as it keep it.
        field_count:
          type: number
          description: >-
            Fields read from new documents: built-in and the firm’s, archived
            ones left out.
        fact_keys:
          type: array
          items:
            type: string
          description: The client facts its fields fill.
        read_last_30_days:
          type: number
          description: Documents of this type read in the last 30 days.
      required:
        - object
        - id
        - key
        - label
        - description
        - group
        - origin
        - holds
        - archived
        - field_count
        - fact_keys
        - read_last_30_days
      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.