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

# Get Tasks

> Returns tasks using cursor-based pagination. Default page size is 50; the maximum is 100.

Send an empty object `{}` for the first page. Page size defaults to **50** and is capped at **100**. If `lastEvaluatedKey` is present in the response, pass it back in the next request to load the following page.


## OpenAPI

````yaml POST /tasks/list
openapi: 3.1.0
info:
  title: Pingmee API
  description: A complete guide to Pingmee micro service architecture.
  version: 1.0.0
servers:
  - url: https://api.pingmee.co.il
security:
  - cookieAuth: []
    ApiKeyAuth: []
paths:
  /tasks/list:
    servers:
      - url: https://business.pingmee.co.il
        description: Business service
    post:
      summary: Get tasks
      description: >-
        Returns tasks using cursor-based pagination. Default page size is 50;
        the maximum is 100.
      requestBody:
        description: >-
          Pagination and filter parameters. Send an empty object `{}` to use
          defaults.
        content:
          application/json:
            schema:
              type: object
              required: []
              properties:
                phoneNumberId:
                  type: string
                  description: Filter tasks by business phone number identifier.
                agentId:
                  type: string
                  description: Filter tasks assigned to this agent.
                participantsIdentifiers:
                  type: string
                  description: >-
                    Filter tasks linked to this conversation
                    (`participantsIdentifiers`).
                lastEvaluatedKey:
                  type: object
                  description: >-
                    Key returned from a previous request. Pass this value to
                    fetch the next page of tasks.
                  additionalProperties: false
                limit:
                  type: integer
                  default: 50
                  minimum: 1
                  maximum: 100
                  description: Maximum number of tasks to return.
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Tasks
          content:
            application/json:
              schema:
                type: object
                properties:
                  dbObject:
                    type: array
                    description: List of tasks returned for this page of results.
                    items:
                      $ref: '#/components/schemas/Task'
                  hasMoreItemsToFetch:
                    type: boolean
                  lastEvaluatedKey:
                    type: object
                    description: >-
                      If present, call the same endpoint again and pass this
                      value as `lastEvaluatedKey` to retrieve the next page of
                      results. Pagination is cursor-based, not page-number
                      based.
                    additionalProperties: false
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Task:
      type: object
      required:
        - taskId
        - title
        - body
        - associatedTo
        - statusCase
        - unreadCount
        - agentIdentification
        - createdAt
        - updatedAt
        - dueDate
      properties:
        taskId:
          type: string
          description: Unique task identifier.
        title:
          type: string
          description: Task title.
        body:
          type: string
          description: Task description / notes.
        associatedTo:
          type: string
          description: Business or account the task is associated with.
        statusCase:
          type: string
          description: >-
            Task status. Built-in values are `open`, `standby` (in progress),
            and `completed`. Custom task status IDs defined for the business are
            also accepted.
        unreadCount:
          type: integer
          description: >-
            Needs-attention counter. Starts at 1 on create and increments on
            every update.
        agentIdentification:
          $ref: '#/components/schemas/AgentIdentification'
        assignedAgentIds:
          type: array
          items:
            type: string
          description: Agent IDs assigned to this task.
        viewedByAgentIds:
          type: array
          items:
            type: string
          description: Agent IDs that have viewed this task.
        createdAt:
          type: number
          description: Unix timestamp (seconds) when the task was created.
        updatedAt:
          type: number
          description: Unix timestamp (seconds) when the task was last updated.
        dueDate:
          type: number
          description: Unix timestamp (seconds) for the due date. `0` when unset.
        phoneNumberId:
          type: string
          description: Business phone number identifier used to scope the task.
        participantsIdentifiers:
          type: string
          description: Conversation participants identifiers this task is linked to.
        customer:
          $ref: '#/components/schemas/Customer'
      additionalProperties: false
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: string
        message:
          type: string
    AgentIdentification:
      type: object
      description: Agent who sent or handled the message
      additionalProperties: false
    Customer:
      type: object
      required: []
      properties:
        profileImage:
          type:
            - string
            - 'null'
          description: Profile image URL if available
        customerName:
          type: string
          description: The name from WhatsApp or the originating platform
        customerNickname:
          type: string
          description: The name the business gave the customer
        description:
          type: string
          description: >-
            Free-text note / description controlled by the business (shown in
            the conversation sidebar)
        createdAt:
          type: number
          description: Unix timestamp (milliseconds) when the customer was created
        lastActiveAt:
          type: number
          description: Unix timestamp (milliseconds) when the customer was last active
        email:
          type: string
          format: email
          description: Customer email address
        platform:
          type: string
          enum:
            - whatsapp
            - instagram
            - facebookMessenger
          description: Messaging platform the customer is associated with
        phoneNumberId:
          type: string
          description: Platform-specific phone number identifier
        countryCode:
          type: string
          description: Country calling code
        associatedTo:
          type: string
          description: Business or account the customer is associated with
        parsedPhoneNumber:
          type: string
          description: Normalized phone number if available
      additionalProperties: false
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: header
      name: Cookie
      description: Personal access token from Pingmee Settings → Developer Tools
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Business API key from Pingmee Settings → Developer Tools

````