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

# Chatwoot status

> Returns the Chatwoot integration status for the WhatsApp number. The number comes from the key scope (number key) or the x-whatsapp-number-id header (tenant key / OAuth). The Chatwoot access token is NEVER returned (only hasToken).



## OpenAPI

````yaml openapi.json GET /v1/chatwoot
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/chatwoot:
    get:
      tags:
        - Chatwoot
      summary: Get Chatwoot status
      description: >-
        Returns the Chatwoot integration status for the WhatsApp number. The
        number comes from the key scope (number key) or the x-whatsapp-number-id
        header (tenant key / OAuth). The Chatwoot access token is NEVER returned
        (only hasToken).
      operationId: get_chatwoot
      parameters:
        - name: x-whatsapp-number-id
          in: header
          required: false
          description: >-
            Scopes to a single number (required for tenant keys / per-number
            OAuth grants).
          schema:
            type: string
          example: num_01HZX...
      responses:
        '200':
          description: Chatwoot integration status
          content:
            application/json:
              example:
                connected: true
                status: connected
                enabled: true
                inboxId: '42'
                instanceUrl: https://app.chatwoot.com
                accountId: '1'
                hasToken: true
                channelMode: auto
                lastError: null
                lastErrorCode: null
                lastSyncAt: '2026-07-13T12:00:00.000Z'
        '400':
          description: >-
            No number resolvable (tenant key / per-number grant without
            x-whatsapp-number-id)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Missing number
                code: NUMBER_REQUIRED
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '404':
          description: The number does not belong to this tenant
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: WhatsApp number not found
                code: NUMBER_NOT_FOUND
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````