Docmost Octri Preview
POST/bases/info

Get a base with its properties and views

Retrieves a base, including its properties, views, and the authenticated user's permissions. Supply the base's page ID as pageId; a base uses the same ID as its page.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

The identifier of the base to retrieve.

pageIdstringrequired
Id of the base. A base *is* a page, so this is the base's page id - the same id you would pass to the page endpoints.

3 status codes
200Returns the base, including its schema and the authenticated user's permissions.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when access to the base is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the base is not found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when the authenticated user is not permitted to access the base. A 404 is returned when no base exists with the supplied pageId. pageId must be a UUID identifying the base's page.