> For the complete documentation index, see [llms.txt](https://docs.idlayr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.idlayr.com/api-reference/management/workspaces.md).

# Workspaces

Read and update your workspace.

## Get a workspace

> Returns the workspace identified by \`workspace\_id\`.

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"tags":[{"name":"workspaces_v1","description":"Read and update your workspace."}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"WorkspaceBearerAuth":[]}],"components":{"securitySchemes":{"WorkspaceBearerAuth":{"description":"Management endpoints expect an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4)\nin the `Authorization` HTTP header, e.g. `Authorization: Bearer {access_token}`.\n\nThe token must be obtained with **workspace credentials** and carry the `management`\nscope. This is distinct from the project `client_id` / `client_secret` credentials used\nto call the product APIs.\n","type":"http","scheme":"bearer"}},"schemas":{"Workspace":{"description":"A workspace — the top-level container for an account.","type":"object","unevaluatedProperties":false,"required":["workspace_id","name","data_residency","created_at"],"properties":{"workspace_id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable workspace name.","type":"string"},"data_residency":{"description":"The region in which the workspace's data is stored.","type":"string","enum":["eu","us"]},"created_at":{"$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"Problem":{"description":"An [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail.","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded. The `Retry-After` header carries\nthe number of seconds after which the caller can retry.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}},"responses":{"Unauthorized":{"description":"The Access Token is missing, invalid, or lacks the `management` scope.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Forbidden":{"description":"The caller is authenticated but not permitted to perform this operation.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"WorkspaceNotFound":{"description":"The workspace identified by `workspace_id` does not exist or is not visible to the caller.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}},"paths":{"/v1/workspaces/{workspace_id}":{"get":{"summary":"Get a workspace","description":"Returns the workspace identified by `workspace_id`.","operationId":"get-workspace-v1","tags":["workspaces_v1"],"responses":{"200":{"description":"The workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/WorkspaceNotFound"},"429":{"$ref":"#/components/responses/RateLimitReached"}}}}}}
```

## Update a workspace

> Updates the workspace using a \[JSON Patch]\(<https://datatracker.ietf.org/doc/html/rfc6902)\\>
> document. Only \`name\` is mutable.<br>

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Management API","version":"1.0.0"},"tags":[{"name":"workspaces_v1","description":"Read and update your workspace."}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"WorkspaceBearerAuth":[]}],"components":{"securitySchemes":{"WorkspaceBearerAuth":{"description":"Management endpoints expect an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4)\nin the `Authorization` HTTP header, e.g. `Authorization: Bearer {access_token}`.\n\nThe token must be obtained with **workspace credentials** and carry the `management`\nscope. This is distinct from the project `client_id` / `client_secret` credentials used\nto call the product APIs.\n","type":"http","scheme":"bearer"}},"schemas":{"JsonPatch":{"description":"A [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) document — an array of operations.","type":"array","items":{"type":"object","unevaluatedProperties":false,"required":["op","path"],"properties":{"op":{"description":"The operation to perform.","type":"string","enum":["add","remove","replace","move","copy","test"]},"path":{"description":"A JSON Pointer to the target location.","type":"string"},"value":{"description":"The value to apply. Required for `add`, `replace`, and `test`."},"from":{"description":"A JSON Pointer to the source location. Required for `move` and `copy`.","type":"string"}}}},"Workspace":{"description":"A workspace — the top-level container for an account.","type":"object","unevaluatedProperties":false,"required":["workspace_id","name","data_residency","created_at"],"properties":{"workspace_id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"Human-readable workspace name.","type":"string"},"data_residency":{"description":"The region in which the workspace's data is stored.","type":"string","enum":["eu","us"]},"created_at":{"$ref":"#/components/schemas/ISODateTime"}}},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"Problem":{"description":"An [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail.","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded. The `Retry-After` header carries\nthe number of seconds after which the caller can retry.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}},"responses":{"BadRequest":{"description":"The request body or patch document is invalid.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Unauthorized":{"description":"The Access Token is missing, invalid, or lacks the `management` scope.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Forbidden":{"description":"The caller is authenticated but not permitted to perform this operation.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"WorkspaceNotFound":{"description":"The workspace identified by `workspace_id` does not exist or is not visible to the caller.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}},"paths":{"/v1/workspaces/{workspace_id}":{"patch":{"summary":"Update a workspace","description":"Updates the workspace using a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902)\ndocument. Only `name` is mutable.\n","operationId":"update-workspace-v1","tags":["workspaces_v1"],"requestBody":{"required":true,"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/JsonPatch"}}}},"responses":{"200":{"description":"The updated workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/WorkspaceNotFound"},"429":{"$ref":"#/components/responses/RateLimitReached"}}}}}}
```


---

# 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.idlayr.com/api-reference/management/workspaces.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.