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

# List Tasks

> List all tasks with optional filtering, pagination, and sorting. Supports comprehensive filtering options including task type, assignment, activity type, and more.



## OpenAPI

````yaml GET /tasks/
openapi: 3.0.0
info:
  title: PlanD API
  description: PlanD Public API
  version: '2'
servers:
  - url: http:localhost:3000/v2
    description: Local Server
  - url: https://beta-api.pland.app/v2
    description: Sandbox Server
  - url: https://cloud-api.pland.app/v2
    description: Production Server
security: []
tags:
  - name: Absences
    description: >-
      Absence management endpoints for creating, updating, and managing user
      absences
  - name: Activity Types
    description: Activity type management operations
  - name: API Keys
    description: API key management operations for programmatic access to the API
  - name: Assignments
    description: Assignment management operations
  - name: Chat (Legacy)
    description: >-
      Legacy chat operations using Stream Chat service (deprecated - use Entity
      Chat v2 instead)
  - name: Client
    description: Unauthenticated client-facing operations
  - name: Company
    description: Company information and settings management operations
  - name: Complaints
    description: Customer complaint and ticket management operations
  - name: Contacts
    description: Contact person management operations
  - name: Customers
    description: Customer management operations
  - name: Customer Objects
    description: >-
      Customer object management operations - locations and buildings where
      services are performed
  - name: Documents
    description: >-
      Document management operations for uploading, retrieving, and managing
      files
  - name: Logbuch
    description: >-
      Operations for sending, retrieving, updating, and deleting Logbuch in
      entity chats.
  - name: Push Notifications
    description: Operations for listing, reading, and deleting user notifications.
  - name: Equipment
    description: Equipment management operations
  - name: Equipment Types
    description: Equipment type management operations
  - name: Assignment Confirmations
    description: Assignment confirmation management operations
  - name: Credit
    description: >-
      Credit note management operations for creating and handling credit
      documents
  - name: Invoice
    description: >-
      Invoice management operations for creating, managing, and processing
      customer invoices
  - name: Invoice Reminders
    description: >-
      Invoice reminder management operations for creating and handling payment
      reminder documents
  - name: Invoice Reminder Templates
    description: >-
      Invoice reminder template management operations for creating and handling
      reminder document templates
  - name: Invoice Storno
    description: Invoice storno (cancellation) document management operations
  - name: Invoice Templates
    description: >-
      Invoice template management operations for creating and handling invoice
      document templates
  - name: Offers
    description: Offer management operations
  - name: ServiceReport
    description: >-
      Service report management operations for creating and handling service
      documentation
  - name: Holiday
    description: Holidays management
  - name: Implementation
    description: User implementation progress tracking and onboarding management
  - name: Jobs
    description: >-
      Endpoints for managing jobs, including creation, listing, updating, and
      job-specific actions.
  - name: Material Orders
    description: Operations for listing, viewing, updating, and managing material orders.
  - name: Notifications
    description: User notification management operations
  - name: Payment Methods
    description: >-
      Payment method management operations for configuring available payment
      options
  - name: Payment Terms
    description: Operations for managing payment terms
  - name: Payments
    description: Payment management operations
  - name: Articles
    description: >-
      Operations for creating, listing, viewing, updating, and deleting
      articles.
  - name: Suppliers
    description: Supplier management operations
  - name: Service Products
    description: >-
      Operations for creating, listing, viewing, updating, and deleting service
      products.
  - name: Quality Control
    description: Quality control and assessment management operations
  - name: Pay Types
    description: Pay type management operations for salary and absence types
  - name: Salary
    description: >-
      Salary management operations for tracking and managing employee
      compensation
  - name: Surcharges
    description: Surcharge management operations for pay types and salary calculations
  - name: Search
    description: Search for entities in PlanD
  - name: Signing
    description: Endpoints for creating and listing signings (digital signatures).
  - name: Tasks
    description: Task management operations
  - name: Task Types
    description: Task type management operations
  - name: Tax Rates
    description: >-
      Tax rate management operations for handling VAT, zero rates, exemptions,
      and reverse charge scenarios
  - name: Time Tracking
    description: >-
      Time tracking management endpoints for recording, monitoring, and managing
      work time entries
  - name: Assets
    description: Asset URL management operations for secure access to uploaded files
  - name: Upload
    description: >-
      CSV and file uploads for various entities (articles, material, users,
      customers, objects, contacts, equipment, images)
  - name: Users
    description: >-
      User management endpoints for creating, updating, and managing system
      users
  - name: Authentication
    description: User authentication and password management operations
  - name: Banking Transactions
    description: Banking transaction management operations
  - name: Webhooks
  - name: SMS
    description: Endpoints for SMS status updates and link tracking.
paths:
  /tasks/:
    get:
      tags:
        - Tasks
      summary: List tasks
      description: >-
        List all tasks with optional filtering, pagination, and sorting.
        Supports comprehensive filtering options including task type,
        assignment, activity type, and more.
      operationId: listTasks
      parameters:
        - name: limit
          in: query
          description: Maximum number of items to return
          required: false
          schema:
            type: integer
            default: 100
            maximum: 1000
            minimum: 1
        - name: offset
          in: query
          description: Number of items to skip for pagination
          required: false
          schema:
            type: integer
            default: 0
            minimum: 0
        - name: sort
          in: query
          description: Sort field and direction (e.g. status.createdAt:-1, dueDate:1)
          required: false
          schema:
            type: string
        - name: customer
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterCustomerId'
        - name: userIds
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterUserIds'
        - name: taskByTitleIdentifier
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterTaskByTitleIdentifier'
        - name: taskAssignee
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterTaskAssignee'
        - name: relatedContacts
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterRelatedContacts'
        - name: relatedUsers
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterRelatedUsers'
        - name: relatedObjects
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterRelatedObjects'
        - name: relatedCustomers
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterRelatedCustomers'
        - name: relatedAssignments
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterRelatedAssignments'
        - name: relatedInvoices
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterRelatedInvoices'
        - name: relatedEquipments
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterRelatedEquipments'
        - name: taskStatus
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterTaskStatus'
        - name: priority
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterPriority'
        - name: callId
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterCallId'
        - name: taskTabs
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterTaskTabs'
        - name: taskType
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterTaskType'
        - name: taskFromRecurringTemplate
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterTaskFromRecurringTemplate'
        - name: status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterStatus'
      responses:
        '200':
          description: List of tasks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Task'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - API-Key: []
        - Bearer-Auth: []
components:
  schemas:
    FilterCustomerId:
      description: Filter by customer IDs
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterUserIds:
      title: Filter for User IDs
      description: >-
        Filter to search jobs by user IDs. If the user ID is "unassigned_jobs",
        it will search for jobs without a user ID.
      type: array
      items:
        description: >-
          User ID to filter jobs by. If "unassigned_jobs" is included, it will
          also search for jobs without a user ID.
        type: string
        format: objectId
      x-internal: true
    FilterTaskByTitleIdentifier:
      description: Filter by task title or identifier
      type: string
      x-internal: true
    FilterTaskAssignee:
      title: Filter for Task Assignee
      description: Filter to search tasks by assignee ID.
      type: array
      items:
        description: Assignee ID to filter tasks by.
        type: string
        format: objectId
      x-internal: true
    FilterRelatedContacts:
      description: Filter by related contacts
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterRelatedUsers:
      description: Filter by related users
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterRelatedObjects:
      description: Filter by related objects
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterRelatedCustomers:
      description: Filter by related customers
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterRelatedAssignments:
      description: Filter by related assignments
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterRelatedInvoices:
      description: Filter by related invoices
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterRelatedEquipments:
      description: Filter by related equipments
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterTaskStatus:
      description: Filter by status (single value or comma-separated list)
      type: string
      x-internal: true
    FilterPriority:
      description: Filter by priority (single value or comma-separated list)
      type: array
      items:
        type: string
      x-internal: true
    FilterCallId:
      description: Filter by call ID (single value or comma-separated list)
      type: array
      items:
        type: string
      x-internal: true
    FilterTaskTabs:
      description: Filter by task tabs
      type: array
      items:
        type: string
      x-internal: true
    FilterTaskType:
      description: Filter by task type
      type: array
      items:
        type: string
        format: objectid
      x-internal: true
    FilterTaskFromRecurringTemplate:
      description: Filter tasks created from recurring templates (true/false)
      type: string
      x-internal: true
    FilterStatus:
      description: Filter by status (single value or comma-separated list)
      type: string
      x-internal: true
    Task:
      title: Task
      description: A single task entity
      required:
        - title
        - identifierNumber
        - status
      type: object
      allOf:
        - $ref: '#/components/schemas/ChatableEntityModel'
        - properties:
            title:
              description: Title of the task
              type: string
              nullable: true
            taskStatus:
              description: Status of the task
              enum:
                - new
                - open
                - in_progress
                - in_review
                - completed
                - cancelled
              nullable: true
            taskType:
              description: Type of the task
              nullable: true
            taskTypeId:
              description: Task type ID
              format: objectid
              nullable: true
            taskTemplate:
              oneOf:
                - $ref: '#/components/schemas/TaskTemplateDto'
              nullable: true
              description: Task template reference
            identifierNumber:
              description: Task identifier number (task number for each task type)
              type: integer
              nullable: true
            description:
              description: Description of the task
              type: string
              nullable: true
            contactPerson:
              description: Contact person of the task
              type: string
              nullable: true
            email:
              description: Email of the task
              type: string
              nullable: true
            telephone:
              description: Telephone of the task
              type: string
              nullable: true
            assignee:
              $ref: '#/components/schemas/RelatedEntity'
            dueDate:
              description: Due date
              nullable: true
            firstStartedAt:
              description: time stamp when the task was first moved away from "new" status
              nullable: true
            firstTerminatedAt:
              description: time stamp when the task was first moved to "completed" status
              nullable: true
            complaintCreatedAt:
              description: >-
                time stamp when the complaint that is the source of this task
                was created (to keep reaction times)
              nullable: true
            tags:
              description: Tags for categorization
              type: array
              items:
                type: string
            priority:
              description: Task priority
              type: string
            related:
              description: Related entities
              type: object
            documentIds:
              description: Document IDs related to this task
              type: array
              items:
                type: string
                format: objectid
            callId:
              description: Call ID related to this task
              type: string
              format: objectid
            completionResponse:
              description: Completion comment or response text
              type: string
              nullable: true
          type: object
    ChatableEntityModel:
      title: Chatable Entity Model
      description: Base class for all entities that can have a chat associated with them.
      type: object
      allOf:
        - $ref: '#/components/schemas/Entity'
        - properties:
            chatId:
              description: ID of the chat associated with this entity
              type: string
              format: objectid
              nullable: true
          type: object
    TaskTemplateDto:
      title: Task Template DTO
      description: A minimal data transfer object for task template references
      properties:
        entityId:
          description: Task template entity ID
          format: objectid
        templateName:
          description: Task template number
          type: string
        recurring:
          description: Is this a recurring task template
          type: boolean
      type: object
    RelatedEntity:
      title: RelatedEntity
      description: An entity related to a task (user, object, customer, etc.)
      required:
        - _id
        - name
        - type
      properties:
        entityId:
          description: The unique identifier of the related entity
          type: string
          format: objectid
        name:
          description: The display name of the related entity
          type: string
          nullable: true
        profilePicture:
          description: URL or identifier for related entity profile image
          type: string
          example: https://example.com/profiles/user123.jpg
          nullable: true
      type: object
    Entity:
      title: Entity
      description: >-
        Base class for all entities in the system, providing common properties
        and methods.
      properties:
        _id:
          description: Unique identifier of the entity
          type: string
          format: objectid
        number:
          description: Unique number of the entity, used for identification
          type: integer
        companyId:
          description: The ID of the company this entity belongs to
          type: string
          format: objectid
          x-internal: true
        status:
          $ref: '#/components/schemas/StatusStruct'
      type: object
    StatusStruct:
      description: Entity Status information
      properties:
        status:
          description: Current status
          type: integer
        createdAt:
          description: Creation timestamp
          type: string
          format: date-time
        createdBy:
          description: User who created this supplier
          type: string
          format: objectid
        lastModifiedAt:
          description: Last modification timestamp
          type: string
          format: date-time
        lastModifiedBy:
          description: User who last modified this supplier
          type: string
          format: objectid
      type: object
  securitySchemes:
    API-Key:
      type: apiKey
      name: x-API-Key
      in: header
    Bearer-Auth:
      type: http
      bearerFormat: JWT
      scheme: bearer

````