Workspaces

Get workspace

Retrieve details of a specific workspace.

Note: This endpoint is available on cloud-hosted Business plans and above, and on licensed self-hosted deployments (Business plan and above). Listing and creating workspaces is available on all plans; unlicensed self-hosted deployments are limited to the default workspace.

get/api/v3/meta/workspaces/{workspaceId}

Request

Base URL
https://app.nocodb.com
Auth
- API key in header xc-token
- or HTTP bearer
TypeScript
https://skmtc.dev/nocodb/apis/nocodb-v3/docs/api/v3/meta/workspaces/:workspaceId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workspaceIdstring required

Unique identifier for the workspace.

Query parameters

includestring[]

Include additional data. Use 'members' to include workspace member information.

Response

Workspace retrieved successfully.

idstring required

Unique identifier for the workspace

titlestring required

Title of the workspace

org_idstring

Organization identifier (required for cloud, absent for on-prem EE)

created_atstring date-time required

Timestamp when the workspace was created

updated_atstring date-time required

Timestamp when the workspace was last updated

Changes

No recorded changes to this operation across all 4 revisions of this API.