Communities Client API
Generated client method reference for the communities namespace.
Communities Client API
Generated file warning: this page is generated by
packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.
This page documents 6 schema-registry client methods in the communities namespace.
getAllCommunities
Get all communities
Overview
| Prop | Value |
|---|---|
| Namespace | communities |
| Action | read |
| Functionality | both |
| Positional parameter order | - |
| Aliases | communities.all, communities.getAll, communities.list, listCommunities |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/communities/getAll | getAllCommunities | Active |
| Alias | GET | /api/communities/all | communities.all | Active |
| Alias | GET | /api/communities/list | communities.list | Active |
| Alias | GET | /api/getAllCommunities | getAllCommunities | Active |
| Alias | GET | /api/listCommunities | listCommunities | Active |
Usage
const result = await client.getAllCommunities({});
// namespaced form: client.communities.getAll(...)Parameters
This method does not define input parameters.
Output
| Prop | Value |
|---|---|
| Return type | string[] |
getCommunityAdminIds
Get community admin IDs
Overview
| Prop | Value |
|---|---|
| Namespace | communities |
| Action | read |
| Functionality | both |
| Positional parameter order | communityId |
| Aliases | communities.getAdminIds |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/communities/getAdminIds | getCommunityAdminIds | Active |
| Alias | GET | /api/getCommunityAdminIds | getCommunityAdminIds | Active |
Usage
const result = await client.getCommunityAdminIds({
communityId: "447123456789-1445627445@g.us",
});
// namespaced form: client.communities.getAdminIds(...)Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | any |
Returns raw, unstructured data from WhatsApp Web. Narrow or validate the shape before relying on specific fields.
getCommunityAdmins
Get community admins
Overview
| Prop | Value |
|---|---|
| Namespace | communities |
| Action | read |
| Functionality | both |
| Positional parameter order | communityId |
| Aliases | communities.getAdmins |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/communities/getAdmins | getCommunityAdmins | Active |
| Alias | GET | /api/getCommunityAdmins | getCommunityAdmins | Active |
Usage
const result = await client.getCommunityAdmins({
communityId: "447123456789-1445627445@g.us",
});
// namespaced form: client.communities.getAdmins(...)Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | any |
Returns raw, unstructured data from WhatsApp Web. Narrow or validate the shape before relying on specific fields.
getCommunityInfo
Get community metadata
Overview
| Prop | Value |
|---|---|
| Namespace | communities |
| Action | read |
| Functionality | both |
| Positional parameter order | communityId |
| Aliases | communities.getInfo |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/communities/getInfo | getCommunityInfo | Active |
| Alias | GET | /api/getCommunityInfo | getCommunityInfo | Active |
Usage
const result = await client.getCommunityInfo({
communityId: "447123456789-1445627445@g.us",
});
// namespaced form: client.communities.getInfo(...)Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | any |
Returns raw, unstructured data from WhatsApp Web. Narrow or validate the shape before relying on specific fields.
getCommunityParticipantIds
Get community participant IDs
Overview
| Prop | Value |
|---|---|
| Namespace | communities |
| Action | read |
| Functionality | both |
| Positional parameter order | communityId |
| Aliases | communities.getParticipantIds |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/communities/getParticipantIds | getCommunityParticipantIds | Active |
| Alias | GET | /api/getCommunityParticipantIds | getCommunityParticipantIds | Active |
Usage
const result = await client.getCommunityParticipantIds({
communityId: "447123456789-1445627445@g.us",
});
// namespaced form: client.communities.getParticipantIds(...)Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | any |
Returns raw, unstructured data from WhatsApp Web. Narrow or validate the shape before relying on specific fields.
getCommunityParticipants
Get community participants
Overview
| Prop | Value |
|---|---|
| Namespace | communities |
| Action | read |
| Functionality | both |
| Positional parameter order | communityId |
| Aliases | communities.getParticipants |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/communities/getParticipants | getCommunityParticipants | Active |
| Alias | GET | /api/getCommunityParticipants | getCommunityParticipants | Active |
Usage
const result = await client.getCommunityParticipants({
communityId: "447123456789-1445627445@g.us",
});
// namespaced form: client.communities.getParticipants(...)Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | any |
Returns raw, unstructured data from WhatsApp Web. Narrow or validate the shape before relying on specific fields.
Was this helpful?
Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!