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

# List

> List tasks with assignee, status and due-date filters

CLI: `adside todos list`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/todos
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/todos:
    get:
      tags:
        - To-dos
      summary: List
      description: |-
        List tasks with assignee, status and due-date filters

        CLI: `adside todos list`
      operationId: todos.list
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: assignee
          in: query
          required: false
          description: >-
            Use agent for agent-assigned follow-ups, or all for people's tasks
            and agent follow-ups together. Managed agents stay scoped to their
            workspace. Omit for people's tasks. Reviewer-backed onboarding
            execution is excluded. Listing without a status filter includes
            closed history.
          schema:
            description: >-
              Use agent for agent-assigned follow-ups, or all for people's tasks
              and agent follow-ups together. Managed agents stay scoped to their
              workspace. Omit for people's tasks. Reviewer-backed onboarding
              execution is excluded. Listing without a status filter includes
              closed history.
            type: string
            enum:
              - agent
              - all
          style: form
          explode: true
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - OPEN
              - DONE
              - CANCELLED
          style: form
          explode: true
        - name: assigneeUserId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          style: form
          explode: true
        - name: source
          in: query
          required: false
          schema:
            type: string
            enum:
              - SLACK
              - WEB
              - CHAT
              - CALL
              - ONBOARDING
          style: form
          explode: true
        - name: unassigned
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: string
                enum:
                  - 'true'
                  - 'false'
          style: form
          explode: true
        - name: dueFrom
          in: query
          required: false
          schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          style: form
          explode: true
        - name: dueTo
          in: query
          required: false
          schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          style: form
          explode: true
        - name: hasDueDate
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: string
                enum:
                  - 'true'
                  - 'false'
          style: form
          explode: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  todos:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        workspaceId:
                          type: string
                        title:
                          type: string
                        body:
                          anyOf:
                            - type: string
                            - type: 'null'
                        status:
                          type: string
                          enum:
                            - OPEN
                            - DONE
                            - CANCELLED
                        dueDate:
                          anyOf:
                            - type: string
                            - type: 'null'
                        assigneeType:
                          type: string
                          enum:
                            - UNASSIGNED
                            - MEMBER
                            - AGENT
                        assignee:
                          anyOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                email:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                image:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                isCurrentMember:
                                  type: boolean
                              required:
                                - id
                                - name
                                - email
                                - image
                                - isCurrentMember
                              additionalProperties: false
                            - type: 'null'
                        source:
                          type: string
                          enum:
                            - SLACK
                            - WEB
                            - CHAT
                            - CALL
                            - ONBOARDING
                        requestedBySlackUserName:
                          anyOf:
                            - type: string
                            - type: 'null'
                        completedAt:
                          anyOf:
                            - type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                            - type: 'null'
                        createdAt:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      required:
                        - id
                        - workspaceId
                        - title
                        - body
                        - status
                        - dueDate
                        - assigneeType
                        - assignee
                        - source
                        - requestedBySlackUserName
                        - completedAt
                        - createdAt
                      additionalProperties: false
                required:
                  - todos
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.