# Karbon Client Groups API

**Canonical:** https://apis.io/apis/karbonhq/karbonhq-client-groups-api/  
**Provider:** Karbon — https://apis.io/providers/karbonhq/  
**Base URL:** https://api.karbonhq.com  
**Documentation:** https://developers.karbonhq.com/

Karbon Client Groups API is one of 19 APIs that [Karbon](https://apis.io/providers/karbonhq/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Client Groups. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and 6 JSON Schemas.

Create a client group to manage related contacts, create work for them, and see all related jobs in a single view. [Read more](https://help.karbonhq.com/en/articles/5880261-manage-a-client-group)

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| GET | `/v3/ClientGroups` | Gets a list of Client Groups |
| POST | `/v3/ClientGroups` | Creates a new Client Group |
| GET | `/v3/ClientGroups/GetClientGroupByUserDefinedIdentifier(UserDefinedIdentifier='{UserDefinedIdentifier}')` | Gets a Client Group using UserDefinedIdentifier |
| GET | `/v3/ClientGroups/{ClientGroupkey}` | Gets a Client Group using ClientGroupkey |
| PUT | `/v3/ClientGroups/{ClientGroupkey}` | Updates a Client Group (Full) |
| PATCH | `/v3/ClientGroups/{ClientGroupkey}` | Updates a Client Group (Partial) |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/karbonhq/refs/heads/main/openapi/karbonhq-client-groups-api-openapi.yml
- **APIReference** — https://karbonhq.github.io/karbon-api-reference/
- **Documentation** — https://developers.karbonhq.com/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/karbonhq/refs/heads/main/json-schema/karbonhq-get-work-schedule-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/karbonhq/refs/heads/main/json-schema/karbonhq-work-schedule-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/karbonhq/refs/heads/main/json-schema/karbonhq-response-create-contact-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/karbonhq/refs/heads/main/json-schema/karbonhq-business-card-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/karbonhq/refs/heads/main/json-schema/karbonhq-response-create-client-group-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/karbonhq/refs/heads/main/json-schema/karbonhq-business-card-request-schema.json

## Other Karbon APIs (12)

- [Karbon Billing API](https://apis.io/apis/karbonhq/karbonhq-billing-api/)
- [Karbon Business Cards API](https://apis.io/apis/karbonhq/karbonhq-business-cards-api/)
- [Karbon Comments API](https://apis.io/apis/karbonhq/karbonhq-comments-api/)
- [Karbon Contacts API](https://apis.io/apis/karbonhq/karbonhq-contacts-api/)
- [Karbon Custom Fields API](https://apis.io/apis/karbonhq/karbonhq-custom-fields-api/)
- [Karbon Estimate Summaries API](https://apis.io/apis/karbonhq/karbonhq-estimate-summaries-api/)
- [Karbon Files API](https://apis.io/apis/karbonhq/karbonhq-files-api/)
- [Karbon Integrated Workflows API](https://apis.io/apis/karbonhq/karbonhq-integrated-workflows-api/)
- [Karbon Notes API](https://apis.io/apis/karbonhq/karbonhq-notes-api/)
- [Karbon Organizations API](https://apis.io/apis/karbonhq/karbonhq-organizations-api/)
- [Karbon Tenant Settings API](https://apis.io/apis/karbonhq/karbonhq-tenant-settings-api/)
- [Karbon Timesheets and Time Entries API](https://apis.io/apis/karbonhq/karbonhq-timesheets-and-time-entries-api/)

## Tags

Client Groups

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/karbonhq/karbonhq-client-groups-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/karbonhq/.