ReferenceSpaces
Get space
Get details for a space in a project
GET/api/v1/projects/{projectUuid}/spaces/{spaceUuid}
Authentication: personal access token. The spec defines an api_key security
scheme — send an Authorization: ApiKey <your-personal-access-token> header
(value format: ApiKey <your key>). A session_cookie scheme (connect.sid)
exists for browser sessions. Operations in this spec declare security: [], an
artifact of the upstream spec generator — authentication is still enforced by the
server.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectUuid | string | Yes | The uuid of the space's parent project |
spaceUuid | string | Yes | The uuid of the space to get |
Responses
200 — Success
{
"results": {
"breadcrumbs": [
{
"hasAccess": true,
"uuid": "string",
"name": "string"
}
],
"path": "string",
"colorPaletteUuid": "string",
"projectMemberAccessRole": {},
"inheritParentPermissions": true,
"parentSpaceUuid": "string",
"childSpaces": [
{
"name": "string",
"slug": "string",
"uuid": "string",
"organizationUuid": "string",
"projectUuid": "string",
"inheritParentPermissions": true,
"projectMemberAccessRole": {},
"pinnedListUuid": "string",
"pinnedListOrder": 0,
"parentSpaceUuid": "string",
"path": "string",
"deletedBy": {
"lastName": "string",
"firstName": "string",
"userUuid": "string"
},
"deletedAt": "2024-01-01T00:00:00.000Z",
"appCount": 0,
"childSpaceCount": 0,
"dashboardCount": 0,
"chartCount": 0
}
],
"slug": "string",
"pinnedListOrder": 0,
"pinnedListUuid": "string",
"groupsAccess": [
{
"spaceRole": "viewer",
"groupName": "string",
"groupUuid": "string"
}
],
"access": [
{
"grantedVia": "app",
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer",
"hasDirectAccess": true,
"role": "viewer",
"userUuid": "string",
"avatarGradient": {},
"avatarUrl": "string",
"isInternal": true,
"email": "string",
"lastName": "string",
"firstName": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"slug": "string",
"updatedAt": "2024-01-01T00:00:00.000Z",
"uuid": "string",
"organizationUuid": "string",
"projectUuid": "string",
"pinnedListUuid": "string",
"pinnedListOrder": 0,
"updatedByUser": {
"userUuid": "string",
"firstName": "string",
"lastName": "string"
},
"spaceUuid": "string",
"views": 0,
"firstViewedAt": "string",
"owner": {
"email": "string",
"lastName": "string",
"firstName": "string",
"userUuid": "string"
},
"verification": {
"verifiedAt": "2024-01-01T00:00:00.000Z",
"verifiedBy": {
"lastName": "string",
"firstName": "string",
"userUuid": "string"
}
},
"validationErrors": [
{
"error": "string",
"createdAt": "2024-01-01T00:00:00.000Z",
"validationUuid": "string",
"validationId": 0
}
]
}
],
"projectUuid": "string",
"queries": [
{
"name": "string",
"description": "string",
"slug": "string",
"dashboardSlug": "string",
"uuid": "string",
"organizationUuid": "string",
"projectUuid": "string",
"pinnedListUuid": "string",
"spaceUuid": "string",
"spaceName": "string",
"dashboardUuid": "string",
"dashboardName": "string",
"source": "dbt_explore",
"chartKind": "line",
"chartType": "cartesian",
"updatedAt": "2024-01-01T00:00:00.000Z",
"pinnedListOrder": 0,
"updatedByUser": {
"userUuid": "string",
"firstName": "string",
"lastName": "string"
},
"firstViewedAt": "2024-01-01T00:00:00.000Z",
"views": 0,
"verification": {
"verifiedAt": "2024-01-01T00:00:00.000Z",
"verifiedBy": {
"lastName": "string",
"firstName": "string",
"userUuid": "string"
}
},
"validationErrors": [
{
"error": "string",
"createdAt": "2024-01-01T00:00:00.000Z",
"validationUuid": "string",
"validationId": 0
}
]
}
],
"inheritsFromOrgOrProject": true,
"name": "string",
"uuid": "string",
"organizationUuid": "string"
},
"status": "ok"
}default — Error
{
"error": {
"data": "string",
"message": "string",
"name": "string",
"statusCode": 0
},
"status": "error"
}