Get group
get_groupRetrieve a single group by ID to view household or company details, members, type, status, applicant answers, preferred companies, and custom fields; include contact details when needed.
Instructions
One group by ID: a household or company (vendors, applicants, landlords, tenants, suppliers) with its members (names by default), type, status, applicant qualification answers, preferred companies and custom fields. Members' emails, phones and addresses only with include_contact_details. Uses GET /api/group/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group_id | Yes | Group ID (a positive whole number) | |
| include_contact_details | No | Include members' email addresses, phone numbers and postal addresses, and stop redacting emails and phone numbers from names, notes and descriptions. Off by default. |