# Groups API Reference

> Source: https://centric-api-docs.certn.co/#groups

Groups are used to organize Cases. Groups can be used to collect cases together and segregate them from
others, to map to a company structure, to organize by end client and/or to allow for separate billing,
and control access in the Client Portal UI.


## Endpoints

| Method | Path | Description |
|--------|------|-------------|
| `GET` | `/api/public/groups/` |  |
| `GET` | `/api/public/groups/{id}/` |  |
| `POST` | `/api/public/groups/{id}/deactivate/` |  |
| `GET` | `/api/public/groups/{id}/list-bundles/` |  |
| `POST` | `/api/public/groups/create/` |  |

### GET /api/public/groups/

Returns a list of all your Groups.

#### Parameters

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | query | string | No |  |
| `is_active` | query | boolean | No |  |
| `name` | query | string | No |  |
| `page` | query | integer | No | A page number within the paginated result set. |
| `page_size` | query | integer | No | Number of results to return per page. Defaults to 10, maximum 100. |
| `parent_id` | query | string | No |  |

#### Example Request

```bash
curl -X GET "https://api.sandbox.certn.co/api/public/groups/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

### GET /api/public/groups/{id}/

Retrieve the details of an individual Group.

#### Parameters

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | string | Yes |  |

#### Example Request

```bash
curl -X GET "https://api.sandbox.certn.co/api/public/groups/{id}/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

### POST /api/public/groups/{id}/deactivate/

This endpoint deactivates a Group, preventing any new Cases from being created under it.

#### Parameters

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | string | Yes |  |

#### Example Request

```bash
curl -X POST "https://api.sandbox.certn.co/api/public/groups/{id}/deactivate/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

### GET /api/public/groups/{id}/list-bundles/

Returns a list of all Bundles available to your Group.

Ensure you have familiarized yourself with the concepts under `Settings > Integrations > Documentation > Introduction`.
when ordering a Bundle as part of a Case.

#### Parameters

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | string | Yes |  |

#### Example Request

```bash
curl -X GET "https://api.sandbox.certn.co/api/public/groups/{id}/list-bundles/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

### POST /api/public/groups/create/

This endpoint allows you to create a new Group under your Customer Account.
The Group can then be used to organize Cases and Users.

#### Example Request

```bash
curl -X POST "https://api.sandbox.certn.co/api/public/groups/create/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

---

*See the [interactive documentation](https://centric-api-docs.certn.co/#groups) for more details.*