# Dimensions

> Tracking categories, such as Property or Department, whose options tag journal lines.

Part of the [Prosaic API reference](https://developer.prosaic.works/docs/api.md). Base URL: `https://app.prosaic.works/api/public/v1`. Authenticate with `Authorization: Bearer <API key or access token>`.

## List dimensions

`GET /api/public/v1/entities/{entityId}/dimensions`

SDK: `prosaic.dimensions.list(entityId)`

Returns the entity's active dimensions (tracking categories such as Property or
Department) with their active options. Use each option's `id` as a value in
`dimensionOptionIds` when creating journals
(`POST /api/public/v1/entities/{entityId}/journals`) or reconciling transactions
(`POST /api/public/v1/entities/{entityId}/transactions/{transactionId}/reconcile`).

Archived dimensions and archived options are excluded. Requires API key
authentication and entity access.

### Path parameters

- `entityId` (string, required)

### Responses

- `200`: Successful response
  - `data` (array of objects, required)
    - `id` (string, required)
    - `name` (string, required)
    - `typeKey` (string, required)
    - `enforcement` (string, required)
    - `options` (array of objects, required)
      - `id` (string, required)
      - `name` (string, required)
      - `code` (string, nullable, required)
  - `meta` (object)
    - `count` (number, required)
- `401`: Invalid or missing API key
- `403`: API key does not have access to this entity

### Example (Node SDK)

```ts
const { data } = await prosaic.dimensions.list(entityId);
```

### Example (curl)

```bash
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/dimensions \
  -H "Authorization: Bearer $PROSAIC_API_KEY"
```