> ## 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.

# Get a client’s checklist

> One checklist of a client with every item, its files and its answers.



## OpenAPI

````yaml /openapi/advisor.json get /clients/{client}/checklists/{checklist}
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}/checklists/{checklist}:
    get:
      tags:
        - Checklists
      summary: Get a client’s checklist
      description: One checklist of a client with every item, its files and its answers.
      operationId: get_checklist
      parameters:
        - name: client
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: The client id, from list_clients.
        - name: checklist
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: The checklist id, from list_client_checklists.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Checklist'
        '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:
            - checklists:read
components:
  schemas:
    Checklist:
      type: object
      properties:
        object:
          type: string
          enum:
            - checklist
        id:
          type: string
        client_id:
          type: string
        name:
          type: string
        template_id:
          anyOf:
            - type: string
            - type: 'null'
        sent_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        progress:
          type: object
          properties:
            done:
              type: number
            total:
              type: number
            submitted:
              type: number
            open:
              type: number
          required:
            - done
            - total
            - submitted
            - open
          additionalProperties: true
        complete:
          type: boolean
          description: Every required item is done.
        items:
          type: array
          items:
            $ref: '#/components/schemas/ChecklistItem'
      required:
        - object
        - id
        - client_id
        - name
        - template_id
        - sent_at
        - progress
        - complete
        - items
      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
    ChecklistItem:
      type: object
      properties:
        object:
          type: string
          enum:
            - checklist_item
        id:
          type: string
        checklist_id:
          type: string
        position:
          type: number
        kind:
          type: string
          enum:
            - document
            - questions
            - connect_banks
          description: >-
            document asks for a file upload; questions is a short form;
            connect_banks asks the client to connect their banks through open
            banking and finishes by itself when they do.
        title:
          type: string
        help:
          anyOf:
            - type: string
            - type: 'null'
        required:
          type: boolean
        questions:
          type: array
          items:
            $ref: '#/components/schemas/ChecklistQuestion'
        prefill_from_facts:
          type: boolean
        state:
          type: string
          enum:
            - todo
            - submitted
            - changes_requested
            - done
          description: >-
            todo (waiting for the client), submitted (waiting for the firm to
            review), changes_requested (sent back with a note), done.
        change_note:
          anyOf:
            - type: string
            - type: 'null'
          description: What the firm asked to change, while the item is changes_requested.
        submitted_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        submitted_by:
          anyOf:
            - type: string
            - type: 'null'
        reviewed_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
        reviewed_by:
          anyOf:
            - type: string
            - type: 'null'
        documents:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              file_name:
                type: string
              page_count:
                anyOf:
                  - type: number
                  - type: 'null'
              uploaded_at:
                type: string
                description: An ISO 8601 time in UTC.
            required:
              - id
              - file_name
              - page_count
              - uploaded_at
            additionalProperties: true
        answers:
          type: array
          items:
            type: object
            properties:
              question_key:
                type: string
              label:
                type: string
              value:
                anyOf:
                  - type: string
                  - type: boolean
              answered_at:
                type: string
                description: An ISO 8601 time in UTC.
              prefilled_from_document_id:
                anyOf:
                  - type: string
                  - type: 'null'
            required:
              - question_key
              - label
              - value
              - answered_at
              - prefilled_from_document_id
            additionalProperties: true
      required:
        - object
        - id
        - checklist_id
        - position
        - kind
        - title
        - help
        - required
        - questions
        - prefill_from_facts
        - state
        - change_note
        - submitted_at
        - submitted_by
        - reviewed_at
        - reviewed_by
        - documents
        - answers
      additionalProperties: true
    ChecklistQuestion:
      type: object
      properties:
        key:
          type: string
        label:
          type: string
        type:
          type: string
          enum:
            - short
            - long
            - date
            - yes_no
            - choice
            - address
          description: >-
            short and long are text, date is YYYY-MM-DD, yes_no is a boolean,
            choice is one of options, address is one line.
        options:
          anyOf:
            - type: array
              items:
                type: string
            - type: 'null'
        fact_key:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - key
        - label
        - type
        - options
        - fact_key
      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.