---
title: Group
slug: group
docTags: 
createdAt: 2021-09-14T17:56:45.000Z
---

A *Carrot* datatype used by fields that store group values.

:::hint{type="info"}
The `Group` datatype is not supported in Custom Fields/Forms. Supported uses for the `Group` datatype include Departments, Teams, Locations, and Bands.
:::

### Properties

The `Group` datatype supports the following properties:

| **Property**                 | **Definition**                                                                                    |
| ---------------------------- | ------------------------------------------------------------------------------------------------- |
| *someGroup*.**id**           | Returns the group ID. Applicable to all group types.                                              |
| *someGroup*.**name**         | Returns the group name. Applicable to all group types.                                            |
| *someGroup*.**code**         | Returns the group code, ex. "CS." Applicable to all group types.                                  |
| *someGroup*.**aliases**      | Returns the group alias. Applicable to all group types.                                           |
| *someGroup*.**address**      | Returns the group address. Only applicable to Locations.                                          |
| *someGroup*.**category**     | Returns the group category. Only applicable to Departments. Interchangeable with Group.func.      |
| *someGroup*.**func**         | Returns the group function. Only applicable to Departments. Interchangeable with Group.category.  |
| *someGroup*.**color**        | Returns the group color. Applicable to all group types.                                           |
| *someGroup*.**locationType** | Returns the location type. Only applicable to Locations.\\                                        |
| *someGroup*.**compMin**      | Returns the minimum base value. Only applicable to Bands.                                         |
| *someGroup*.**compMax**      | Returns the maximum base value. Only applicable to Bands.                                         |
| *someGroup*.**level**        | Returns the group level. Only applicable to Bands.                                                |

### Sample usage

`department:"customer service"` returns all records where `department`, a default field of type `Group`, has a value of `customer service`.