API Referencespaces

Get a space

View as Markdown
Get one complete space, including its environment.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

spaceIdstring or "default"Required

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Response

OK
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
environmentobject
idstring
Unique space identifier generated by BCTRL.
isDefaultboolean
namestring1-200 characters
regionenum
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error