Get client group
get_client_groupRetrieve a client group by its Karbon key or your own external identifier, with optional expansion of related business card and team data.
Instructions
Get a single client group by ClientGroupKey — or by your own UserDefinedIdentifier — optionally expanding related data (BusinessCard, ClientTeam). Includes the group's members (contacts and organizations). Provide exactly one of clientGroupKey or userDefinedIdentifier.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| expand | No | Comma-separated related data to include: BusinessCard, ClientTeam | |
| clientGroupKey | No | The Karbon ClientGroupKey | |
| userDefinedIdentifier | No | Look up by your own external ID instead of the ClientGroupKey |