> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
> Use this file to discover all available pages before exploring further.

# unit

> sift/unit/v2/unit.proto

<a name="sift_unit_v2_unit-proto" />

<a name="sift_unit_v2_unit-proto-services" />

## Services

*RPC methods exposed by this API.*

### UnitService

| Method     | Request                                 | Response                                  | Description |
| :--------- | :-------------------------------------- | :---------------------------------------- | :---------- |
| CreateUnit | [CreateUnitRequest](#createunitrequest) | [CreateUnitResponse](#createunitresponse) |             |
| ListUnits  | [ListUnitsRequest](#listunitsrequest)   | [ListUnitsResponse](#listunitsresponse)   |             |

<a name="sift_unit_v2_unit-proto-messages" />

## Messages

*Data models used across requests/responses.*

### CreateUnitRequest

| Field | Type   | Label | Description |
| :---- | :----- | :---- | :---------- |
| name  | string |       |             |

### CreateUnitResponse

| Field | Type          | Label | Description |
| :---- | :------------ | :---- | :---------- |
| unit  | [Unit](#unit) |       |             |

### ListUnitsRequest

| Field       | Type   | Label | Description                                                                                                                                                                                                                                                                                                                                                                                                                               |
| :---------- | :----- | :---- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| page\_size  | uint32 |       | The maximum number of units to return. The service may return fewer than this value. If unspecified, at most 50 units will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.                                                                                                                                                                                                                             |
| page\_token | string |       | A page token, received from a previous `ListUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUnits` must match the call that provided the page token.                                                                                                                                                                                                                    |
| filter      | string |       | A Common Expression Language (CEL, [https://github.com/google/cel-spec](https://github.com/google/cel-spec)) filter string. Available tag variables are: - abbreviated\_name - name - created\_date - unit\_id                                                                                                                                                                                                                            |
| order\_by   | string |       | How to order the retrieved campaigns. Formatted as a comma-separated string i.e. "FIELD\_NAME\[ desc],...". Available fields to order\_by are `name`, `created_date`, and `abbreviated_name`. If left empty, items are ordered by `created_date` in ascending order (oldest-first). For more information about the format of this field, read [this](https://google.aip.dev/132#ordering) Example: "created\_date desc,abbreviated\_name" |

### ListUnitsResponse

| Field             | Type          | Label    | Description                                                                                                                  |
| :---------------- | :------------ | :------- | :--------------------------------------------------------------------------------------------------------------------------- |
| units             | [Unit](#unit) | repeated |                                                                                                                              |
| next\_page\_token | string        |          | A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. |

### Unit

| Field             | Type   | Label | Description |
| :---------------- | :----- | :---- | :---------- |
| unit\_id          | string |       |             |
| abbreviated\_name | string |       |             |

<a name="sift_unit_v2_unit-proto-enums" />

## Enums

*Allowed constant values used in message fields.*