WhatsApp

WhatsApp Join Requests API

The Join Requests API from WhatsApp — 1 operation(s) for join requests.

GitHub OpenAPI

Operations 3

GET /{Version}/{group_id}/join_requests Get Join Requests #
POST /{Version}/{group_id}/join_requests Approve Join Requests #
DELETE /{Version}/{group_id}/join_requests Reject Join Requests #

Documentation

📖
Documentation
https://developers.facebook.com/documentation/business-messaging/whatsapp/overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/whatsapp/openapi/whatsapp-join-requests-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/meta/openapi

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-request-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-business-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-business-profile-node-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-phone-number-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-permission-check-response-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-account-number-schema.json

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/WhatsApp/WhatsApp-Flows-Tools/main/postman/v1/whatsapp-cloud-api.postman_collection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/whatsapp:whatsapp-join-requests-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

whatsapp-join-requests-api-openapi.yml Raw ↑ 
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: Join Requests
paths:
  /{Version}/{group_id}/join_requests:
    get:
      summary: Get Join Requests
      description: Get a list of open join requests for a group
      operationId: getJoinRequests
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: Version
        in: path
        required: true
        schema:
          type: string
      - name: group_id
        in: path
        required: true
        description: Group ID
        schema:
          type: string
      responses:
        '200':
          description: List of join requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        join_request_id:
                          type: string
                          description: Join request ID
                          example: MTY0NjcwNDM1OTU6MTIwMzYzNDA0Njk0MjMzODIw
                        wa_id:
                          type: string
                          description: WhatsApp user ID
                          example: '16505551234'
                        creation_timestamp:
                          type: integer
                          description: Unix timestamp indicating when the join request was created
                          example: 1755548877
                  paging:
                    $ref: '#/components/schemas/PagingInfo'
      security:
      - bearerAuth: []
      tags:
      - Join Requests
    post:
      summary: Approve Join Requests
      description: Approve one or more join requests
      operationId: approveJoinRequests
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/ContentType'
      - name: Version
        in: path
        required: true
        schema:
          type: string
      - name: group_id
        in: path
        required: true
        description: Group ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - messaging_product
              - join_requests
              properties:
                messaging_product:
                  type: string
                  enum:
                  - whatsapp
                join_requests:
                  type: array
                  description: Array of join request IDs to approve
                  items:
                    type: string
                    description: Join request ID
                    example: MTY0NjcwNDM1OTU6MTIwMzYzNDA0Njk0MjMzODIw
      responses:
        '200':
          description: Join requests approval response
          content:
            application/json:
              schema:
                type: object
                properties:
                  messaging_product:
                    type: string
                    example: whatsapp
                  approved_join_requests:
                    type: array
                    items:
                      type: string
                      description: ID of approved join request
                  failed_join_requests:
                    type: array
                    items:
                      type: object
                      properties:
                        join_request_id:
                          type: string
                        errors:
                          type: array
                          items:
                            $ref: '#/components/schemas/Error'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      tags:
      - Join Requests
    delete:
      summary: Reject Join Requests
      description: Reject one or more join requests
      operationId: rejectJoinRequests
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/ContentType'
      - name: Version
        in: path
        required: true
        schema:
          type: string
      - name: group_id
        in: path
        required: true
        description: Group ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - messaging_product
              - join_requests
              properties:
                messaging_product:
                  type: string
                  enum:
                  - whatsapp
                join_requests:
                  type: array
                  description: Array of join request IDs to reject
                  items:
                    type: string
                    description: Join request ID
      responses:
        '200':
          description: Join requests rejection response
          content:
            application/json:
              schema:
                type: object
                properties:
                  messaging_product:
                    type: string
                    example: whatsapp
                  rejected_join_requests:
                    type: array
                    items:
                      type: string
                      description: ID of rejected join request
                  failed_join_requests:
                    type: array
                    items:
                      type: object
                      properties:
                        join_request_id:
                          type: string
                        errors:
                          type: array
                          items:
                            $ref: '#/components/schemas/Error'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      tags:
      - Join Requests
components:
  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
    ContentType:
      name: Content-Type
      in: header
      description: Media type of the request body
      required: true
      schema:
        type: string
        enum:
        - application/json
        - application/x-www-form-urlencoded
        - multipart/form-data
        default: application/json
        example: application/json
  schemas:
    Error:
      type: object
      properties:
        code:
          type: integer
          description: Error code
        message:
          type: string
          description: Error message
        title:
          type: string
          description: Error title
        error_data:
          type: object
          properties:
            details:
              type: string
              description: Error details
    PagingInfo:
      type: object
      properties:
        cursors:
          type: object
          properties:
            before:
              type: string
              description: Before cursor
            after:
              type: string
              description: After cursor
        previous:
          type: string
          description: Previous page URL
        next:
          type: string
          description: Next page URL
  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

        '