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

# Inspect WhatsApp messaging apps

> List the authenticated customer's reply-only WhatsApp definitions, installations, linked Interchange members, conversation-binding counts, and content-free inbound receipt status. Provider credentials, actor digests, message content, and raw webhook payloads are never returned. Requires a directly authenticated active organization administrator.



## OpenAPI

````yaml /v2/buyer-api-v2.yaml get /messaging-apps/whatsapp
openapi: 3.0.0
info:
  title: Scope3 Buyer API
  version: 2.0.0
  description: |-
    REST API for advertisers to manage advertisers, campaigns, and reporting.

    ## Authentication

    All endpoints require a Bearer token in the Authorization header:
    ```
    Authorization: Bearer your-api-key
    ```

    ## Base URL

    `https://api.interchange.io/api/v2/buyer`

    ## For AI Agents

    AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools:
    - `initialize`: Start an MCP session
    - `api_call`: Make REST API calls
    - `ask_about_capability`: Learn about API features
servers:
  - url: https://api.interchange.io/api/v2/buyer
    description: Production server
security: []
tags:
  - name: Signup
    description: Request reviewed access to Interchange
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Asks
    description: >-
      What you are waiting on Scope3 for — support, product, and supply asks in
      one list
  - name: Advertisers
    description: Manage advertisers
  - name: Product Discovery
    description: Discover and select products
  - name: Campaigns
    description: Manage advertising campaigns
  - name: Creatives
    description: Build, manage, and sync campaign creatives via AdCP Creative Protocol
  - name: Reporting
    description: Access performance metrics
  - name: Event Sources
    description: >-
      Manage event source configurations and log conversion/marketing events for
      attribution
  - name: Property Lists
    description: Validate property lists against AAO registry
  - name: Sales Agents
    description: View and connect sales agents
  - name: Measurement
    description: Measurement sources, records, context, and freshness
  - name: Syndication
    description: Syndicate resources to ADCP agents
  - name: Tasks
    description: Track async operation status
  - name: Buyer Billing
    description: >-
      Consolidated invoicing for buyers — invoices and pending invoice items
      issued by Scope3 across the buyer customer.
  - name: MCP
    description: Model Context Protocol endpoints for AI agents
paths:
  /messaging-apps/whatsapp:
    servers:
      - url: https://api.interchange.io/api/v2
        description: Production server
    get:
      tags:
        - Account
      summary: Inspect WhatsApp messaging apps
      description: >-
        List the authenticated customer's reply-only WhatsApp definitions,
        installations, linked Interchange members, conversation-binding counts,
        and content-free inbound receipt status. Provider credentials, actor
        digests, message content, and raw webhook payloads are never returned.
        Requires a directly authenticated active organization administrator.
      operationId: listWhatsAppMessagingApps
      responses:
        '200':
          description: Inspect WhatsApp messaging apps
          content:
            application/json:
              schema:
                type: object
                properties:
                  definitions:
                    type: array
                    items:
                      type: object
                      properties:
                        definition:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            customerId:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              maximum: 9007199254740991
                            agentKey:
                              type: string
                              minLength: 1
                              maxLength: 128
                            brand:
                              type: object
                              properties:
                                displayName:
                                  type: string
                                  minLength: 1
                                  maxLength: 80
                                shortDescription:
                                  type: string
                                  minLength: 1
                                  maxLength: 200
                                accentColor:
                                  type: string
                                  pattern: ^#[0-9a-f]{6}$
                                iconAssetId:
                                  type: string
                                  format: uuid
                                  pattern: >-
                                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                                supportUrl:
                                  type: string
                                  format: uri
                                  pattern: ^https:\/\/.*
                                privacyPolicyUrl:
                                  type: string
                                  format: uri
                                  pattern: ^https:\/\/.*
                                termsUrl:
                                  type: string
                                  format: uri
                                  pattern: ^https:\/\/.*
                              required:
                                - displayName
                                - supportUrl
                                - privacyPolicyUrl
                              additionalProperties: false
                            providerRef:
                              oneOf:
                                - type: object
                                  properties:
                                    provider:
                                      type: string
                                      enum:
                                        - slack
                                    applicationId:
                                      type: string
                                      minLength: 1
                                      maxLength: 2048
                                  required:
                                    - provider
                                    - applicationId
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    provider:
                                      type: string
                                      enum:
                                        - teams
                                    applicationId:
                                      type: string
                                      minLength: 1
                                      maxLength: 2048
                                  required:
                                    - provider
                                    - applicationId
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    provider:
                                      type: string
                                      enum:
                                        - discord
                                    applicationId:
                                      type: string
                                      minLength: 1
                                      maxLength: 2048
                                  required:
                                    - provider
                                    - applicationId
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    provider:
                                      type: string
                                      enum:
                                        - whatsapp
                                    businessAccountId:
                                      type: string
                                      minLength: 1
                                      maxLength: 2048
                                    phoneNumberId:
                                      type: string
                                      minLength: 1
                                      maxLength: 2048
                                  required:
                                    - provider
                                    - businessAccountId
                                    - phoneNumberId
                                  additionalProperties: false
                              type: object
                            status:
                              type: string
                              enum:
                                - draft
                                - active
                                - retired
                          required:
                            - id
                            - customerId
                            - agentKey
                            - brand
                            - providerRef
                            - status
                          additionalProperties: false
                        credentialConfigured:
                          type: boolean
                        installations:
                          type: array
                          items:
                            type: object
                            properties:
                              installation:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    format: uuid
                                    pattern: >-
                                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                                  appDefinitionId:
                                    type: string
                                    format: uuid
                                    pattern: >-
                                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                                  customerId:
                                    type: integer
                                    minimum: 0
                                    exclusiveMinimum: true
                                    maximum: 9007199254740991
                                  providerRef:
                                    oneOf:
                                      - type: object
                                        properties:
                                          provider:
                                            type: string
                                            enum:
                                              - slack
                                          applicationId:
                                            type: string
                                            minLength: 1
                                            maxLength: 2048
                                          workspaceId:
                                            type: string
                                            minLength: 1
                                            maxLength: 2048
                                        required:
                                          - provider
                                          - applicationId
                                          - workspaceId
                                        additionalProperties: false
                                      - type: object
                                        properties:
                                          provider:
                                            type: string
                                            enum:
                                              - teams
                                          applicationId:
                                            type: string
                                            minLength: 1
                                            maxLength: 2048
                                          tenantId:
                                            type: string
                                            minLength: 1
                                            maxLength: 2048
                                          location:
                                            oneOf:
                                              - type: object
                                                properties:
                                                  kind:
                                                    type: string
                                                    enum:
                                                      - personal
                                                  userId:
                                                    type: string
                                                    minLength: 1
                                                    maxLength: 2048
                                                required:
                                                  - kind
                                                  - userId
                                                additionalProperties: false
                                              - type: object
                                                properties:
                                                  kind:
                                                    type: string
                                                    enum:
                                                      - team
                                                  teamId:
                                                    type: string
                                                    minLength: 1
                                                    maxLength: 2048
                                                required:
                                                  - kind
                                                  - teamId
                                                additionalProperties: false
                                              - type: object
                                                properties:
                                                  kind:
                                                    type: string
                                                    enum:
                                                      - channel
                                                  teamId:
                                                    type: string
                                                    minLength: 1
                                                    maxLength: 2048
                                                  channelId:
                                                    type: string
                                                    minLength: 1
                                                    maxLength: 2048
                                                required:
                                                  - kind
                                                  - teamId
                                                  - channelId
                                                additionalProperties: false
                                            type: object
                                        required:
                                          - provider
                                          - applicationId
                                          - tenantId
                                          - location
                                        additionalProperties: false
                                      - type: object
                                        properties:
                                          provider:
                                            type: string
                                            enum:
                                              - discord
                                          applicationId:
                                            type: string
                                            minLength: 1
                                            maxLength: 2048
                                          installContext:
                                            type: string
                                            enum:
                                              - guild
                                              - user
                                          ownerId:
                                            type: string
                                            minLength: 1
                                            maxLength: 2048
                                        required:
                                          - provider
                                          - applicationId
                                          - installContext
                                          - ownerId
                                        additionalProperties: false
                                      - type: object
                                        properties:
                                          provider:
                                            type: string
                                            enum:
                                              - whatsapp
                                          businessAccountId:
                                            type: string
                                            minLength: 1
                                            maxLength: 2048
                                          phoneNumberId:
                                            type: string
                                            minLength: 1
                                            maxLength: 2048
                                        required:
                                          - provider
                                          - businessAccountId
                                          - phoneNumberId
                                        additionalProperties: false
                                    type: object
                                  status:
                                    type: string
                                    enum:
                                      - active
                                      - suspended
                                      - uninstalled
                                  installedAt:
                                    type: string
                                    format: date-time
                                    pattern: >-
                                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                                required:
                                  - id
                                  - appDefinitionId
                                  - customerId
                                  - providerRef
                                  - status
                                  - installedAt
                                additionalProperties: false
                              credentialConfigured:
                                type: boolean
                              identityBindings:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    bindingId:
                                      type: string
                                      format: uuid
                                      pattern: >-
                                        ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                                    userId:
                                      type: integer
                                      minimum: 0
                                      exclusiveMinimum: true
                                      maximum: 9007199254740991
                                    userEmail:
                                      type: string
                                      minLength: 1
                                    userName:
                                      type: string
                                      minLength: 1
                                    linkedByUserId:
                                      type: integer
                                      minimum: 0
                                      exclusiveMinimum: true
                                      maximum: 9007199254740991
                                    permissionLevel:
                                      nullable: true
                                      type: string
                                      enum:
                                        - BASIC
                                        - PREMIUM
                                        - ADMIN
                                        - SUPER_ADMIN
                                    membershipActive:
                                      type: boolean
                                    status:
                                      type: string
                                      enum:
                                        - active
                                        - revoked
                                    verifiedAt:
                                      type: string
                                      format: date-time
                                      pattern: >-
                                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                                    revokedAt:
                                      nullable: true
                                      type: string
                                      format: date-time
                                      pattern: >-
                                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                                  required:
                                    - bindingId
                                    - userId
                                    - userEmail
                                    - userName
                                    - linkedByUserId
                                    - permissionLevel
                                    - membershipActive
                                    - status
                                    - verifiedAt
                                    - revokedAt
                                  additionalProperties: false
                              conversationBindings:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  direct:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  channel:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  lastBoundAt:
                                    nullable: true
                                    type: string
                                    format: date-time
                                    pattern: >-
                                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                                required:
                                  - total
                                  - direct
                                  - channel
                                  - lastBoundAt
                                additionalProperties: false
                              inboundReceipts:
                                type: object
                                properties:
                                  received:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  processing:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  completed:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  ignored:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  failed:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  lastReceivedAt:
                                    nullable: true
                                    type: string
                                    format: date-time
                                    pattern: >-
                                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                                required:
                                  - received
                                  - processing
                                  - completed
                                  - ignored
                                  - failed
                                  - lastReceivedAt
                                additionalProperties: false
                            required:
                              - installation
                              - credentialConfigured
                              - identityBindings
                              - conversationBindings
                              - inboundReceipts
                            additionalProperties: false
                        webhookEndpoint:
                          type: string
                          pattern: ^\/webhooks\/murph\/whatsapp\/.*
                      required:
                        - definition
                        - credentialConfigured
                        - installations
                        - webhookEndpoint
                      additionalProperties: false
                required:
                  - definitions
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Active organization admin required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
      description: Standard error response
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable error message
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
      description: Structured error object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````