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

# Get a scheduled send



## OpenAPI

````yaml /openapi.yml get /send/schedules/{schedule_id}
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: |
    This API is used for sending whatsapp via API.

    The web dashboard is a separate project (gowa-ui); the server downloads its
    latest release asset and serves it at `/` (or returns a JSON banner when
    APP_UI_ENABLED=false).

    Device scoping:
    - Send `X-Device-Id` on all device-scoped REST calls.
    - WebSocket: connect to `/ws?device_id=<id>`.
    - WebSocket auth (when basic auth is enabled): browsers cannot set an
      Authorization header on WebSocket connections, so also pass
      `&authorization=<base64(user:pass)>` in the query string. Use TLS in
      production since the credential is visible in the URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Initial Connection to Whatsapp server
  - name: device
    description: Device management for multi-device support
  - name: user
    description: Getting information
  - name: send
    description: Send Message (Text/Image/File/Video).
  - name: message
    description: Message manipulation (revoke/react/update).
  - name: call
    description: Call management (reject incoming calls)
  - name: chat
    description: Chat conversations and messaging
  - name: group
    description: Group setting
  - name: newsletter
    description: newsletter setting
  - name: chatwoot
    description: Chatwoot integration for customer support
paths:
  /send/schedules/{schedule_id}:
    get:
      tags:
        - send
      summary: Get a scheduled send
      operationId: getScheduledSend
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - $ref: '#/components/parameters/ScheduleIdPath'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleResponse'
        '404':
          description: Schedule not found for this device
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Device identifier for multi-device support. Required when multiple
        devices are registered.

        If only one device is registered, it will be used as the default.

        Can also be provided as `device_id` query parameter.
      schema:
        type: string
        example: my-device-id
    ScheduleIdPath:
      name: schedule_id
      in: path
      required: true
      schema:
        type: string
      description: Schedule ID returned as `schedule_id` by a scheduled send
  schemas:
    ScheduleResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Schedule fetched
        results:
          $ref: '#/components/schemas/Schedule'
    ErrorNotFound:
      type: object
      properties:
        code:
          type: string
          example: 404
          description: HTTP Status Code
        message:
          type: string
          example: Chat not found
          description: Detail error message
        results:
          type: object
          example: null
          description: additional data
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: you are not loggin
          description: Detail error message
        results:
          type: object
          example: null
          description: additional data
    Schedule:
      type: object
      properties:
        id:
          type: string
          example: 0b5c3a8e-7f5d-4d6f-9d1e-2f8c1a7b9e10
        message_type:
          type: string
          enum:
            - text
            - image
            - file
            - video
            - audio
            - sticker
            - contact
            - link
            - location
            - poll
            - forward
          example: text
        phone:
          type: string
          example: 6289685028129@s.whatsapp.net
        summary:
          type: string
          example: selamat pagi
          description: Short preview of the message
        status:
          type: string
          enum:
            - active
            - running
            - paused
            - completed
            - failed
            - cancelled
          example: active
          description: |
            - `active`: waiting for its next run
            - `running`: claimed by the worker and sending
            - `paused`: held until resumed
            - `completed`: no runs left
            - `failed`: gave up after retries or a validation error
            - `cancelled`: cancelled by the user
        scheduled_at:
          type: string
          format: date-time
          example: '2026-10-01T02:00:00Z'
        next_run_at:
          type: string
          format: date-time
          example: '2026-10-01T02:00:00Z'
          description: Omitted when no run is left
        timezone:
          type: string
          example: Asia/Jakarta
        recurrence:
          type: string
          enum:
            - once
            - daily
            - weekly
            - monthly
          example: once
        weekdays:
          type: array
          items:
            type: integer
          example:
            - 1
            - 3
            - 5
        day_of_month:
          type: integer
          example: 15
        end_at:
          type: string
          format: date-time
        occurrence_limit:
          type: integer
          example: 10
        occurrence_count:
          type: integer
          example: 0
          description: Number of successful sends so far
        attempts:
          type: integer
          example: 0
          description: Failed attempts for the current run
        last_run_at:
          type: string
          format: date-time
        last_message_id:
          type: string
          example: 3EB0B430B6F8F1D0E053AC120E0A9E5C
        last_error:
          type: string
        created_at:
          type: string
          format: date-time
          example: '2026-09-25T08:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-09-25T08:00:00Z'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

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