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

# Get sender status

> Current connection status of one WhatsApp sender.

**Required scope:** `whatsapp.view`


## OpenAPI

````yaml /api-reference/openapi.json get /whatsapp/senders/{id}/status
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /whatsapp/senders/{id}/status:
    get:
      summary: Get sender status
      description: Current connection status of one WhatsApp sender.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Sender ID
      responses:
        '200':
          description: Sender status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsappSenderSummary'
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.

            - `sender_not_found`: WhatsApp sender not found.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
components:
  schemas:
    WhatsappSenderSummary:
      type: object
      properties:
        id:
          type: string
        mode:
          type: string
          enum:
            - SHARED
            - BYON
            - API
        status:
          type: string
          enum:
            - CONNECTING
            - CONNECTED
            - DISCONNECTED
            - REVOKED
        numberSource:
          type: string
          enum:
            - PLATFORM_SHARED
            - CLIENT_OWNED
            - PINEYARD_POOL
        isDefault:
          type: boolean
        phoneDisplay:
          type: string
          nullable: true
        hasCredentials:
          type: boolean
        connectedAt:
          type: string
          nullable: true
        verifiedName:
          type: string
          nullable: true
        qualityRating:
          type: string
          nullable: true
      required:
        - id
        - mode
        - status
        - numberSource
        - isDefault
        - phoneDisplay
        - hasCredentials
        - connectedAt
        - verifiedName
        - qualityRating
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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