openapi: 3.0.0
info:
  title: Aloft API V1 Accounts Checklists API
  contact:
    email: support@aloft.ai
  version: 1.0.0
  description: Accounts
tags:
- name: Checklists
  description: Checklists
paths:
  /v1/account/{account_id}/checklists:
    get:
      tags:
      - Checklists
      summary: Get all checklists
      description: Get all checklists
      operationId: 8886ce16011f838b5c74aef06ea6f0b0
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: order_by
        in: query
        description: The field to order the data by
        schema:
          type: string
          enum:
          - id
          - created_by
          - last_edited_by
          - version
          - title
          - retired_at
          - created_at
          - updated_at
      - name: order
        in: query
        schema:
          $ref: '#components/schemas/order_direction'
      - name: search
        in: query
        description: A text field for search the title
        schema:
          type: string
      - name: exclude_retired
        in: query
        description: If true will exclude retired checklist
        schema:
          type: boolean
        example: true
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            description: A list of models to attach
            type: string
            enum:
            - checklistExecutions
            - originalChecklist
            - retired
            - tags
      - name: tags_required
        in: query
        description: When true, all tags must be connected to the object
        schema:
          type: boolean
      - name: tags[]
        in: query
        description: array of category numbers
        schema:
          type: array
          items:
            description: A tag group id
            type: integer
      - name: page
        in: query
        schema:
          type: integer
      - name: page_length
        in: query
        schema:
          type: integer
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '200':
          description: Successful operation
          content:
            application/json: {}
            application/csv: {}
      security:
      - Aloft Token: []
    post:
      tags:
      - Checklists
      summary: Create a checklist
      description: Create a checklist
      operationId: 8c246d4d13e3e966a60077397bff05cd
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            description: A list of models to attach
            type: string
            enum:
            - checklistExecutions
            - originalChecklist
            - retired
            - tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#components/schemas/checklist'
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '200':
          description: Successful operation
      security:
      - Aloft Token: []
  /v1/account/{account_id}/checklists/{checklist_id}:
    get:
      tags:
      - Checklists
      summary: Get a checklist
      description: Get a checklist
      operationId: 290ff8e975a4facbab63950a631b30a8
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            description: A list of models to attach
            type: string
            enum:
            - checklistExecutions
            - originalChecklist
            - retired
            - tags
      - name: checklist_id
        in: path
        description: Checklist ID
        required: true
        schema:
          type: integer
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '200':
          description: Successful operation
      security:
      - Aloft Token: []
    put:
      tags:
      - Checklists
      summary: Update a checklist
      description: Update a checklist
      operationId: 39f5783c24f5eec947e0340d6809448b
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            description: A list of models to attach
            type: string
            enum:
            - checklistExecutions
            - originalChecklist
            - tags
            - retired
      - name: checklist_id
        in: path
        description: Checklist ID
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#components/schemas/checklist'
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable Content
        '200':
          description: Successful operation
      security:
      - Aloft Token: []
    delete:
      tags:
      - Checklists
      summary: Delete a checklist
      description: Delete a checklist
      operationId: 48a10abd106cadd4e37b7f7e5e784403
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: checklist_id
        in: path
        description: Checklist Id.
        required: true
        schema:
          type: integer
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '204':
          description: Successful operation
      security:
      - Aloft Token: []
components:
  securitySchemes:
    Aloft Token:
      type: http
      name: Aloft Token
      in: header
      scheme: bearer