> For the complete documentation index, see [llms.txt](https://docs.akenza.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.akenza.io/device-management/managing-a-workspace/general-settings/workspace-properties.md).

# Workspace properties

Attach your own metadata to a workspace as a JSON object, readable through the REST API.

**Workspace properties** hold additional metadata about a workspace as a free-form **JSON object**. The object is available through the [REST API](/reference/api-documentation.md), which makes it a useful place to keep information your own applications and integrations need to read alongside the workspace.

Typical uses are describing the site a workspace represents, recording identifiers from another system such as an ERP or IWMS, or storing configuration that a feature or an integration of yours reads at runtime.

## Editing the object

Open **Workspace properties** on the [General settings](/device-management/managing-a-workspace/general-settings.md) page, edit the JSON in the editor, and select *Save settings*. The content must be a single valid JSON object.

```json
{
  "onboardingConfig": {
    "spatialModelUrl": "https://example.com/spatial-model.json"
  }
}
```

Some akenza features read their own configuration from a reserved key in this object. The `onboardingConfig` key shown above is one such example, pointing at a spatial model used during device onboarding.

{% hint style="warning" %}
The editor replaces the whole object, so an application that writes here through the API and a person editing in the UI can overwrite each other. Read the current value before writing a new one, and keep keys that belong to other consumers intact.
{% endhint %}

{% hint style="info" %}
Workspace properties describe the **workspace**. To attach structured information to individual devices, use [custom fields](/device-management/managing-a-workspace/custom-fields.md) instead, which are searchable and can be shown as columns in the asset inventory.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.akenza.io/device-management/managing-a-workspace/general-settings/workspace-properties.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.