Skip to main content

User Space API

Read-only endpoints that any authenticated user can call to retrieve details about their organisation, project, spaces, and features.

Unlike the System API, these endpoints do not require X-Server-Key — they are scoped to the calling user's identity via X-Org-Id, X-Project-Id, and X-User-Id.

Get Project Detail​

Returns full details of the project including database connection metadata.

GET /minimal/rest/user/v1/project/detail

Required Headers​

HeaderDescription
X-Org-IdOrganisation identifier
X-Project-IdProject identifier
X-User-IdAuthenticated user's identifier

Get Project​

Returns a summary of the project.

GET /minimal/rest/user/v1/project

Required Headers​

HeaderDescription
X-Org-IdOrganisation identifier
X-Project-IdProject identifier
X-User-IdAuthenticated user's identifier

Get Org Detail​

Returns full details of the organisation.

GET /minimal/rest/user/v1/org/detail

Required Headers​

HeaderDescription
X-Org-IdOrganisation identifier
X-Project-IdProject identifier
X-User-IdAuthenticated user's identifier

Get Org​

Returns a summary of the organisation.

GET /minimal/rest/user/v1/org

Required Headers​

HeaderDescription
X-Org-IdOrganisation identifier
X-Project-IdProject identifier
X-User-IdAuthenticated user's identifier

Get Spaces​

Returns all spaces available to the user under the specified organisation and project.

GET /minimal/rest/user/v1/space

Required Headers​

HeaderDescription
X-Org-IdOrganisation identifier
X-Project-IdProject identifier
X-User-IdAuthenticated user's identifier

Get Features​

Returns all features available to the user under the specified organisation and project.

GET /minimal/rest/user/v1/feature

Required Headers​

HeaderDescription
X-Org-IdOrganisation identifier
X-Project-IdProject identifier
X-User-IdAuthenticated user's identifier

Common Errors​

CodeCause
400Missing or malformed header
401Missing X-User-Id header
404Org or project not found — check X-Org-Id and X-Project-Id