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

# List tasks

> List or start tasks.

Tokens: the relay key, and the token of a Lead you let move the board. A route a token reaches can still refuse it, as the description says.

From docs/manual/relay.html#routes.



## OpenAPI

````yaml https://raw.githubusercontent.com/bfalkowski/Building58/main/docs/openapi.json get /channels/{channel}/tasks
openapi: 3.1.0
info:
  title: Building58 relay
  version: 2.0.0
  description: >-
    The relay passes commands to a world's page and runs the room: tickets,
    tasks, sessions and reviews. It answers this computer only. Each route's
    description is the manual's, from docs/manual/relay.html, where the fields,
    the tokens and the errors are.
  license:
    name: PolyForm Noncommercial 1.0.0
    identifier: PolyForm-Noncommercial-1.0.0
servers:
  - url: http://localhost:8787
    description: The relay on this computer. npm run office starts it on 8787.
security:
  - relayKey: []
  - relayKeyQuery: []
  - sessionToken: []
tags:
  - name: calls
    description: 'Calls any caller uses: commands, events and the page.'
  - name: autopilot
  - name: chat
  - name: checkouts
  - name: floor
  - name: games
  - name: huddle
  - name: needs-you
  - name: officers
  - name: old-relays
  - name: play
  - name: pr-watch
  - name: ready
  - name: reviews
  - name: rounds
  - name: settings
  - name: tasks
  - name: terminals
  - name: tickets
  - name: update
paths:
  /channels/{channel}/tasks:
    get:
      tags:
        - tasks
      summary: List tasks
      description: >-
        List or start tasks.


        Tokens: the relay key, and the token of a Lead you let move the board. A
        route a token reaches can still refuse it, as the description says.


        From docs/manual/relay.html#routes.
      operationId: listTasks
      parameters:
        - name: channel
          in: path
          required: true
          description: >-
            The channel, such as office: 1 to 64 letters, numbers, dashes or
            underscores.
          schema:
            type: string
            pattern: ^[\w-]{1,64}$
      responses:
        2XX:
          description: Done.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskList'
        default:
          $ref: '#/components/responses/Problem'
components:
  schemas:
    TaskList:
      type: object
      properties:
        ok:
          const: true
        states:
          type: array
          items:
            type: string
            enum:
              - building
              - in_review
              - changes_requested
              - waiting_on_you
              - done
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/Task'
      required:
        - ok
        - tasks
      additionalProperties: true
    Task:
      type: object
      properties:
        id:
          type: string
          pattern: ^[0-9a-f]{6}$
        title:
          type: string
        state:
          type: string
          enum:
            - building
            - in_review
            - changes_requested
            - waiting_on_you
            - done
        branch:
          type:
            - string
            - 'null'
        pr:
          type:
            - string
            - 'null'
        ticket:
          type:
            - string
            - 'null'
        repo:
          type: string
        base:
          type:
            - string
            - 'null'
        worktree:
          type:
            - string
            - 'null'
        briefed:
          type: boolean
        owner:
          type:
            - object
            - 'null'
        worker:
          type:
            - object
            - 'null'
        history:
          type: array
          items:
            type: object
            properties:
              at:
                type: string
              type:
                type: string
            required:
              - at
            additionalProperties: true
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - title
        - state
      additionalProperties: true
      description: A session's token gets only id, state, title, branch and pr.
    Problem:
      type: object
      properties:
        ok:
          const: false
        error:
          type: string
          description: A short code, such as bad_param, forbidden or not_found.
        message:
          type: string
          description: What went wrong, in plain words.
      required:
        - ok
        - error
        - message
      additionalProperties: true
  responses:
    Problem:
      description: >-
        Refused. 400 for a bad body, 401 for no key, 403 for a key or token that
        may not, 404 for an unknown route or id, 409 for a state that does not
        allow it, 413 for a body over 256 KB, 429 for too soon, 503 and 504 when
        no page answers.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    relayKey:
      type: http
      scheme: bearer
      description: 'The relay key, RELAY_KEY: Authorization: Bearer <key>.'
    relayKeyQuery:
      type: apiKey
      in: query
      name: key
      description: The relay key in the address, as the page sends it.
    sessionToken:
      type: http
      scheme: bearer
      description: >-
        A session's own token, OFFICE_TICKET_TOKEN. It reaches only the routes
        its role needs: see docs/manual/relay.html#tokens.

````

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