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

# List the invitation dispatches of the caller company

> Delivery status per send. Recipient PII is never included; use the targets to correlate a dispatch to a tool/woku/form.



## OpenAPI

````yaml /openapi-v1.json get /v1/dispatches
openapi: 3.0.0
info:
  title: Woku Client API v1
  description: >-
    Public REST API for programmatic management of woku Voice-of-Customer
    programs: trackers, VoC instruments (NPS, woku, CES, CSAT), action plans,
    support tickets, multi-channel sending and response capture. Requests are
    company-scoped by the API key; never send a company id.
  version: 1.0.0
  contact:
    name: Woku
    url: https://woku.app
    email: team@woku.app
servers:
  - url: https://clientapi.woku.app
    description: Production
security: []
tags: []
paths:
  /v1/dispatches:
    get:
      tags:
        - v1 - dispatches
      summary: List the invitation dispatches of the caller company
      description: >-
        Delivery status per send. Recipient PII is never included; use the
        targets to correlate a dispatch to a tool/woku/form.
      operationId: V1DispatchesController_list
      parameters:
        - name: channel
          required: false
          in: query
          description: Outbound channel of the send.
          schema:
            type: string
            enum:
              - email
              - whatsapp
        - name: responseType
          required: false
          in: query
          description: Only dispatches targeting this tool kind.
          schema:
            type: string
            enum:
              - woku
              - nps
              - form
              - client-form
              - csat
              - ces
        - name: targetId
          required: false
          in: query
          description: Only dispatches targeting this specific tool/woku/form id.
          schema:
            type: string
            format: ObjectId
        - name: createdFrom
          required: false
          in: query
          description: Lower bound for createdAt (ISO 8601).
          schema:
            type: string
        - name: createdTo
          required: false
          in: query
          description: Upper bound for createdAt (ISO 8601).
          schema:
            type: string
        - name: status
          required: false
          in: query
          description: Lifecycle status of the whole invitation.
          schema:
            type: string
            enum:
              - invited
              - partially_responded
              - responded
              - failed
        - name: page
          required: false
          in: query
          schema:
            minimum: 1
            default: 1
            type: number
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            default: 20
            type: number
      responses:
        '200':
          description: Paginated dispatches
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponseDto'
      security:
        - bearer: []
components:
  schemas:
    ValidationErrorResponseDto:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 400
        message:
          description: Array of validation error messages
          example:
            - email must be a valid email
            - password must be at least 8 characters
          type: array
          items:
            type: string
        error:
          type: string
          description: Error type
          example: Bad Request
      required:
        - statusCode
        - message
        - error
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Company secret API key.

````