WhatsApp · WhatsApp

List join requests

Returns join requests.

GEThttps://api.pozy.ai/v1/whatsapp/wa-groups/{groupId}/join-requests

listWhatsAppGroupJoinRequests

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`groupId`required	string

Query parameters

Name	Type	Notes
`accountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/whatsapp/wa-groups/6ddaba11e244da442f65cb22/join-requests?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/whatsapp/wa-groups/6ddaba11e244da442f65cb22/join-requests?accountId=696e0b682d0a31188e7a2ba9", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/whatsapp/wa-groups/6ddaba11e244da442f65cb22/join-requests",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

successboolean
joinRequestsarray of object
- userstring
- timestampinteger

200 response

{
  "success": true,
  "joinRequests": [
    {
      "user": "string",
      "timestamp": 1
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in WhatsApp

POSTRegister a connected WhatsApp number on the Cloud API POSTRequest a Meta re-verification code for a BYO WhatsApp number POSTVerify the Meta re-verification code for a BYO WhatsApp number GETDownload WhatsApp media GETList templates POSTCreate template GETGet template PATCHUpdate template DELDelete template GETGet template by id PATCHUpdate template by id DELDelete template by id GETList the catalogs linked to a WhatsApp number POSTLink a catalog to a WhatsApp number DELUnlink a catalog from a WhatsApp number GETGet a number's commerce settings PUTUpdate a number's commerce settings GETGet ice breakers and commands POSTSet ice breakers and commands DELClear ice breakers and commands GETGet business profile POSTUpdate business profile POSTUpload profile picture GETGet display name status POSTRequest display name change GETGet business username POSTSet business username DELDelete business username GETGet username suggestions GETCheck if a user is blocked GETList blocked users POSTBlock users DELUnblock users GETList account notifications GETGet CTWA conversions dataset POSTProvision CTWA dataset GETList active groups POSTCreate group GETGet group info POSTUpdate group settings DELDelete group POSTAdd participants DELRemove participants POSTCreate invite link POSTApprove join requests DELReject join requests GETList conversion events POSTSend WhatsApp conversion event