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

# DataDocFolder

> Sample shape for DataDocFolder.

Sample shape for `DataDocFolder`.

## Sample JSON

Copy, edit, paste. Server-set fields (`id`, `created`, `tenantId`, …) are omitted from the example — they're populated by the server on response.

```json theme={null}
{
  "name": "Example name",
  "color": "example",
  "restrictedTo": [
    "example"
  ],
  "archived": false
}
```

## Fields

| Field          | Type               | Required   | Notes                                   |
| -------------- | ------------------ | ---------- | --------------------------------------- |
| `entity`       | string • nullable  | Server-set | Set by the server. Read-only on writes. |
| `name`         | string             | Optional   |                                         |
| `color`        | string             | Optional   |                                         |
| `restrictedTo` | array\<string>     | Optional   |                                         |
| `archived`     | boolean            | Optional   |                                         |
| `tenantId`     | string             | Server-set | Set by the server. Read-only on writes. |
| `id`           | string             | Server-set | Set by the server. Read-only on writes. |
| `created`      | string (date-time) | Server-set | Set by the server. Read-only on writes. |
| `createdBy`    | string             | Server-set | Set by the server. Read-only on writes. |
| `updated`      | string (date-time) | Server-set | Set by the server. Read-only on writes. |
| `updatedBy`    | string             | Server-set | Set by the server. Read-only on writes. |
| `deleted`      | boolean            | Server-set | Set by the server. Read-only on writes. |

## Used by

### Request body

* `POST /api/docs/folder`
* `PUT /api/docs/folder/{folderId}`

### Response body

* `GET /api/docs/folder/{folderId}`
* `GET /api/docs/folder`
* `POST /api/docs/folder`

### CLI

`ekso docs folder` — see the [command branches](/cli/branches) page for available verbs. Body for create / update verbs typically passed via `--data @file.json` matching the [sample JSON](#sample-json) above.