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

# List worklist tasks

> Returns your worklist tasks, ordered by priority (high first) then most recent. Internal assignee user IDs, assembly-task workflow links, and the free-form metadata blob are not exposed.



## OpenAPI

````yaml /api-reference/openapi.json get /worklist
openapi: 3.1.0
info:
  title: AutoPrintFarm Public API
  version: 1.0.0
  description: >-
    Public API for AutoPrintFarm — read + write surface for printers, jobs,
    inventory, orders, SKUs, files, worklist, and assembly. Authorization uses
    three scopes: `read` (any list/get), `write` (data mutations — create,
    update, delete, uploads, fulfillment), and `control` (physical printer
    actions: start, pause, resume, stop, heaters, light, filament). Authenticate
    with an API key minted from Settings → API Keys in the AutoPrintFarm
    dashboard.
  contact:
    name: AutoPrintFarm
    url: https://autoprintfarm.com
servers:
  - url: https://api.autoprintfarm.com/public/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Printers
    description: Printer fleet status
  - name: Jobs
    description: Print job queue and history
  - name: Inventory
    description: Finished-goods stock levels
  - name: Orders
    description: Customer orders and line items
  - name: Wiki
    description: Internal documentation articles
  - name: Worklist
    description: Operational task queue
  - name: Products
    description: Product catalog, SKUs, components, and color presets
  - name: Files
    description: Print file metadata and versions
  - name: Hubs
    description: Hub fleet and connection status
  - name: Assembly
    description: Post-print assembly tasks with bundled wiki
  - name: Materials
    description: Filament, components, packaging, and printer parts inventory
  - name: Analytics
    description: >-
      Dashboard rollups and reporting (overview, production, printers, failures,
      inventory, revenue)
paths:
  /worklist:
    get:
      tags:
        - Worklist
      summary: List worklist tasks
      description: >-
        Returns your worklist tasks, ordered by priority (high first) then most
        recent. Internal assignee user IDs, assembly-task workflow links, and
        the free-form metadata blob are not exposed.
      parameters:
        - schema:
            type: string
            enum:
              - pending
              - in_progress
              - completed
              - cancelled
            description: Filter by task status
          required: false
          description: Filter by task status
          name: status
          in: query
        - schema:
            type: string
            enum:
              - assembly
              - filament_change
              - collection
              - maintenance
              - quality_check
            description: Filter by task type
          required: false
          description: Filter by task type
          name: task_type
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: Maximum number of rows to return (1-100)
          required: false
          description: Maximum number of rows to return (1-100)
          name: limit
          in: query
        - schema:
            type:
              - integer
              - 'null'
            minimum: 0
            default: 0
            description: Number of rows to skip for pagination
          required: false
          description: Number of rows to skip for pagination
          name: offset
          in: query
      responses:
        '200':
          description: Worklist task list
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorklistTask'
                  meta:
                    type: object
                    properties:
                      limit:
                        type: number
                      offset:
                        type: number
                      count:
                        type: number
                    required:
                      - limit
                      - offset
                      - count
                required:
                  - success
                  - data
                  - meta
        '401':
          description: Missing, invalid, revoked, or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (120 req/min/key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - read
components:
  schemas:
    WorklistTask:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        subtitle:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        task_type:
          type: string
        priority:
          type:
            - string
            - 'null'
        status:
          type:
            - string
            - 'null'
        printer_id:
          type:
            - string
            - 'null'
        estimated_time_minutes:
          type:
            - number
            - 'null'
        actual_time_minutes:
          type:
            - number
            - 'null'
        started_at:
          type:
            - string
            - 'null'
        completed_at:
          type:
            - string
            - 'null'
        due_date:
          type:
            - string
            - 'null'
        created_at:
          type:
            - string
            - 'null'
        updated_at:
          type:
            - string
            - 'null'
      required:
        - id
        - title
        - subtitle
        - description
        - task_type
        - priority
        - status
        - printer_id
        - estimated_time_minutes
        - actual_time_minutes
        - started_at
        - completed_at
        - due_date
        - created_at
        - updated_at
    Error:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR,
                FORBIDDEN, HUB_OFFLINE). Stable across releases — use this for
                branching.
              example: NOT_FOUND
            message:
              type: string
              description: >-
                Human-readable error message. May vary across releases — do not
                branch on this.
              example: Resource not found
            details:
              description: >-
                Optional structured detail. For VALIDATION_ERROR this is `{
                field: [messages] }`.
          required:
            - code
            - message
          description: Error detail object
      required:
        - success
        - error
      description: Standard error response envelope
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: apf_live_<64 hex>
      description: >-
        API keys are minted in the AutoPrintFarm web app under Settings → API
        Keys. Send as `Authorization: Bearer apf_live_...`. Keys are shown
        exactly once at creation and can be revoked at any time.

````