WhatsApp WhatsApp Business Account On-Behalf Requests API

openapi: 3.2.0
info:
  title: Meta Graph API - Application Connected Client Businesses…
  version: v23.0
  description: 'API for retrieving connected client businesses associated with a Meta application.


    This endpoint allows applications to retrieve information about businesses that have

    established client connections through the application. This is essential for managing

    business relationships and understanding client business configurations.'
  contact:
    name: Meta Business Platform Team
    url: https://developers.facebook.com/support
  license:
    name: Meta Platform Terms
    url: https://developers.facebook.com/terms
  termsOfService: https://developers.facebook.com/terms
servers:
- url: https://graph.facebook.com
  description: Production Graph API server
- url: https://graph.facebook.com
- url: https://graph.facebook.com
  description: WhatsApp Business Cloud API
- url: https://graph.facebook.com
  description: Meta Graph API production server
tags:
- name: WhatsApp Business Account On-Behalf Requests
  description: APIs for managing WhatsApp Business Account on-behalf requests and business relationships
paths:
  /{Version}/{WABA-ID}/in_progress_onbehalf_request:
    get:
      summary: Get In-Progress On-Behalf Requests
      description: 'Retrieve a list of in-progress on-behalf requests for the specified WhatsApp Business Account.

        These requests represent pending business relationship requests that have been sent from

        this WhatsApp Business Account to other businesses and are awaiting approval.


        **Use Cases:**

        - Monitor pending on-behalf requests sent from your WhatsApp Business Account

        - Track business partnership request status and workflow

        - Retrieve details about requesting and receiving businesses for pending requests

        - Manage business relationship approval processes


        **Rate Limiting:**

        Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.


        **Pagination:**

        This endpoint supports cursor-based pagination. Use the ''after'' and ''before'' parameters

        to navigate through large result sets. The response includes pagination URLs for convenience.'
      operationId: getInProgressOnBehalfRequests
      tags:
      - WhatsApp Business Account On-Behalf Requests
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: Version
        in: path
        required: true
        description: 'Graph API version to use for this request. Determines the API behavior and available features.

          '
        schema:
          type: string
          pattern: ^v[0-9]+\.[0-9]+$
        example: v23.0
      - name: WABA-ID
        in: path
        required: true
        description: 'Your WhatsApp Business Account ID. This ID can be found in your WhatsApp Business

          Manager or through the WhatsApp Business Account APIs.

          '
        schema:
          type: string
          pattern: ^[0-9]+$
        example: '1234567890123456'
      - name: fields
        in: query
        required: false
        description: 'Comma-separated list of fields to include in the response. If not specified,

          default fields will be returned (id, status, business_owned_object).

          Available fields: id, status, business_owned_object, receiving_business, requesting_business

          '
        schema:
          type: string
        example: id,status,receiving_business,requesting_business
      - name: limit
        in: query
        required: false
        description: 'Maximum number of results to return per page. Default is 25, maximum is 100.

          '
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 25
        example: 25
      - name: after
        in: query
        required: false
        description: 'Cursor for forward pagination. Use this to get the next page of results.

          '
        schema:
          type: string
        example: CURSOR_AFTER_PLACEHOLDER
      - name: before
        in: query
        required: false
        description: 'Cursor for backward pagination. Use this to get the previous page of results.

          '
        schema:
          type: string
        example: CURSOR_BEFORE_PLACEHOLDER
      responses:
        '200':
          description: Successfully retrieved in-progress on-behalf requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InProgressOnBehalfRequestResponse'
              examples:
                with_requests:
                  summary: Response with in-progress requests
                  value:
                    data:
                    - id: '1234567890123456'
                      status: IN_PROGRESS
                      business_owned_object: '9876543210987654'
                      receiving_business:
                        id: '5678901234567890'
                        name: Partner Business LLC
                      requesting_business:
                        id: '2345678901234567'
                        name: My Business Inc
                    - id: '2345678901234567'
                      status: IN_PROGRESS
                      business_owned_object: '9876543210987654'
                      receiving_business:
                        id: '3456789012345678'
                        name: Another Partner Corp
                      requesting_business:
                        id: '2345678901234567'
                        name: My Business Inc
                    paging:
                      cursors:
                        after: CURSOR_AFTER_PLACEHOLDER
                        before: CURSOR_BEFORE_PLACEHOLDER
                      paging:
                        next: https://graph.facebook.com/v23.0/1234567890123456/in_progress_onbehalf_request?after=CURSOR_AFTER_PLACEHOLDER
                empty_response:
                  summary: Response with no in-progress requests
                  value:
                    data: []
        '400':
          description: Bad Request - Invalid parameters or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: 'Invalid parameter: whatsapp_business_account_id must be a valid numeric string'
                  type: OAuthException
                  code: 100
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '401':
          description: Unauthorized - Invalid or missing access token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Invalid OAuth access token
                  type: OAuthException
                  code: 190
                  error_subcode: 463
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '403':
          description: Forbidden - Insufficient permissions or access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Your app doesn't have permission to access this WhatsApp Business Account
                  type: OAuthException
                  code: 200
                  error_subcode: 1349174
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  error_user_title: Permission Denied
                  error_user_msg: Your app doesn't have permission to access this resource
        '404':
          description: Not Found - WhatsApp Business Account ID does not exist or is not accessible
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: WhatsApp Business Account not found
                  type: GraphMethodException
                  code: 803
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '422':
          description: Unprocessable Entity - Request parameters are valid but cannot be processed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: The requested fields are not available for this request
                  type: GraphMethodException
                  code: 100
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '429':
          description: Too Many Requests - Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Application request limit reached
                  type: OAuthException
                  code: 4
                  error_subcode: 2446079
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  is_transient: true
        '500':
          description: Internal Server Error - Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: An unexpected error occurred. Please retry your request
                  type: GraphMethodException
                  code: 2
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  is_transient: true
      security:
      - bearerAuth: []
components:
  schemas:
    BusinessRequestStatus:
      type: string
      description: Current status of the business request
      enum:
      - APPROVE
      - DECLINE
      - IN_PROGRESS
      - EXPIRED
      - PENDING
      - CANCELED
      - INVALID
      example: IN_PROGRESS
    InProgressOnBehalfRequestResponse:
      type: object
      description: Response containing in-progress on-behalf requests with pagination
      required:
      - data
      properties:
        data:
          type: array
          description: Array of in-progress on-behalf requests
          items:
            $ref: '#/components/schemas/BusinessOwnedObjectOnBehalfOfRequest'
        paging:
          $ref: '#/components/schemas/PaginationInfo'
    GraphAPIError:
      type: object
      description: Standard Graph API error response
      required:
      - error
      properties:
        error:
          type: object
          required:
          - message
          - type
          - code
          properties:
            message:
              type: string
              description: Human-readable error message
              example: Invalid parameter
            type:
              type: string
              description: Error category type
              example: OAuthException
            code:
              type: integer
              description: Numeric error code
              example: 100
            error_subcode:
              type: integer
              description: More specific error subcode when available
              example: 33
            fbtrace_id:
              type: string
              description: Unique identifier for debugging and support requests with Meta
              example: AXsgnV2Cm3ZMGF3dF_cfYIn
            is_transient:
              type: boolean
              description: Indicates whether this error is temporary and the request should be retried
              example: false
            error_user_title:
              type: string
              description: User-friendly error title for display purposes
              example: Permission Denied
            error_user_msg:
              type: string
              description: User-friendly error message for display purposes
              example: Your app doesn't have permission to access this resource
    BusinessNode:
      type: object
      description: Business entity associated with the user
      properties:
        id:
          type: string
          description: Unique identifier for the business
          example: '9876543210987654'
        name:
          type: string
          description: Name of the business
          example: Example Business Inc
    BusinessOwnedObjectOnBehalfOfRequest:
      type: object
      description: On-behalf request details for business owned objects
      required:
      - id
      - status
      - business_owned_object
      properties:
        id:
          type: string
          description: Unique identifier for the on-behalf request
          example: '1234567890123456'
        status:
          $ref: '#/components/schemas/BusinessRequestStatus'
        business_owned_object:
          type: string
          description: ID of the business owned object (WhatsApp Business Account) for this request
          example: '9876543210987654'
        receiving_business:
          $ref: '#/components/schemas/BusinessNode'
        requesting_business:
          $ref: '#/components/schemas/BusinessNode'
    PaginationInfo:
      type: object
      description: Pagination information for navigating through results
      properties:
        cursors:
          type: object
          description: Pagination cursors for navigation
          properties:
            before:
              type: string
              description: Cursor for the previous page of results
              example: MAZDZD
            after:
              type: string
              description: Cursor for the next page of results
              example: MTAxNTExOTQ1MjAwNzI5NDE=
        previous:
          type: string
          format: uri
          description: URL for the previous page of results
          example: https://graph.facebook.com/v23.0/1234567890123456/message_history?before=MAZDZD
        next:
          type: string
          format: uri
          description: URL for the next page of results
          example: https://graph.facebook.com/v23.0/1234567890123456/message_history?after=MTAxNTExOTQ1MjAwNzI5NDE=
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: 'Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

        '
      required: true
      schema:
        type: string
        pattern: ^Bearer\s+[A-Za-z0-9\-_.]+.*$
        example: Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...
    UserAgent:
      name: User-Agent
      in: header
      description: The user agent string identifying the client software making the request.
      required: false
      schema:
        type: string
        default: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
        pattern: ^[a-zA-Z0-9\-_]+\/[0-9]+\.[0-9]+\.[0-9]+(;[a-zA-Z0-9\-=\.]+)?(\s+[a-zA-Z0-9\-_]+\/[0-9\-\.]+)?$
        example: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'System user access token with whatsapp_business_management permission. Format: Bearer YOUR_SYSTEM_USER_ACCESS_TOKEN

        '