Portal Community
API endpoint: Calls GET /{groupId}?fields=id,subject,description. Returns the group subject, description, and ID. Use group/getParticipants to retrieve the member list separately.

When to Use

Configuration

Connection

FieldRequiredDescription
accessTokenRequiredPermanent System User access token. Store in BizFirst Credentials Manager.
phoneNumberIdRequiredNumeric string ID of the business phone number that is a member/admin of the group.
apiVersionOptionalMeta Graph API version. Defaults to v18.0.

Operation

FieldRequiredDescription
groupIdRequiredThe WhatsApp group ID (e.g. 120363xxxxxxxxxx@g.us) stored when the group was created.

Sample Configuration

{
  "resource": "group",
  "operation": "get",
  "accessToken": "{{ $credentials.whatsAppToken }}",
  "phoneNumberId": "123456789012345",
  "groupId": "120363xxxxxxxxxx@g.us"
}

Validation Errors

ErrorCause
accessToken is requiredThe accessToken field is empty.
phoneNumberId is requiredNo Phone Number ID supplied.
groupId is requiredNo group ID provided.
100 (Meta)Group not found — the group has been deleted or the phone number is not a member.
200 (Meta)Insufficient permissions to read this group.

Output

Success Port

FieldTypeDescription
groupIdstringThe group ID.
subjectstringCurrent group name/subject.
descriptionstringCurrent group description. May be null if not set.
statusstring"success".
rawResponsestringFull raw JSON from the Meta Graph API.

Error Port

FieldTypeDescription
groupIdstringGroup ID echoed from input.
statusstring"failed" or "error".
errorCodestringMeta error code or "timeout".
errorMessagestringHuman-readable error description.

Sample Output

{
  "groupId": "120363xxxxxxxxxx@g.us",
  "subject": "Project Alpha Team",
  "description": "Daily standup and project updates for Project Alpha.",
  "status": "success"
}

Expression Reference

ValueExpressionNotes
Group subject{{ $output.getGroup.subject }}Compare to expected name to detect external renames.
Group description{{ $output.getGroup.description }}Display in admin portals or audit reports.
Group ID{{ $output.getGroup.groupId }}Confirm the correct group was retrieved before performing operations on it.

Node Policies & GuardRails

Policy AreaRecommendation
Credential storageStore the access token in BizFirst Credentials Manager.
Error portConnect the error port. A 100 not-found error means the group was deleted externally — update your database accordingly and halt downstream group operations.
Stale data preventionDo not cache group metadata for more than a few minutes. Group subjects and descriptions can change at any time by any group admin.

Examples

Group Existence Check Before Broadcast

{
  "resource": "group",
  "operation": "get",
  "accessToken": "{{ $credentials.whatsAppToken }}",
  "phoneNumberId": "123456789012345",
  "groupId": "{{ $input.groupId }}"
}

Before a scheduled group broadcast, this node confirms the group still exists. If a 100 error is returned, the workflow branches to an error path that marks the group as deleted in the database and notifies the operator to create a new group before retrying the broadcast.

Pre-Rename Audit

{
  "resource": "group",
  "operation": "get",
  "accessToken": "{{ $credentials.whatsAppToken }}",
  "phoneNumberId": "123456789012345",
  "groupId": "{{ $workflow.groupId }}"
}

Before a group rename operation, this node captures the current subject and logs it as the "before" state. After group/update succeeds, the "before" and "after" values are written to the audit log with the timestamp and the identity of the workflow that initiated the rename.