Read a workspace

Requires current workspace membership. All workspace roles can read this resource, including when archived.

GET /api/v1/workspaces/{id}

Operation: getWorkspace · Download OpenAPI

Access

Requires an authenticated Localisync panel session. The API checks current membership and permissions for workspace operations. See authentication and request rules.

sessionCookie

{
  "type": "apiKey",
  "in": "cookie",
  "name": "__Host-localisync-session"
}

Parameters

Name	Location	Required	Description
`id`	path	Yes	See constraints below.

id

{
  "type": "string",
  "format": "uuid"
}

Request body

No request body.

Responses

200

Completed.

Content type: application/json Schema reference: Workspace.

Field	Type	Required	Constraints / description
`id`	string	Yes	format: `"uuid"`
`name`	string	Yes	—
`ownerIdentityId`	string	Yes	format: `"uuid"`
`version`	integer	Yes	minimum: `1`
`archivedAt`	string or null	Yes	format: `"date-time"`
`createdAt`	string	Yes	format: `"date-time"`
`role`	`Owner`, `Admin`, `Editor`, `Viewer`	Yes	—

{
  "$ref": "#/components/schemas/Workspace"
}

400

Invalid request fields, identifier, pagination or idempotency key.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—

{
  "$ref": "#/components/schemas/Error"
}

401

An authenticated, verified customer session is required.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—

{
  "$ref": "#/components/schemas/Error"
}

403

The current member lacks permission or CSRF/Origin validation failed.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—

{
  "$ref": "#/components/schemas/Error"
}

404

The resource is missing or not visible to the current customer.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—

{
  "$ref": "#/components/schemas/Error"
}

409

Stale version, conflicting idempotency key or unavailable invitation/workspace state.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—

{
  "$ref": "#/components/schemas/Error"
}

429

Request or invitation send limit reached. Respect Retry-After in seconds; route limits return the remaining window, invitation limits return 60.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—

{
  "$ref": "#/components/schemas/Error"
}

503

A required database, identity or email service is unavailable; no successful send is claimed.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—

{
  "$ref": "#/components/schemas/Error"
}

Request errors and safe retries · Troubleshooting