Skip to main content
The Objects API is coming soon. Object-level permission management is not yet in place — only actions have proper authorization today. Once object permissions are implemented, the Objects API will provide full CRUD access to domain objects.

Planned Endpoints

The following endpoints are planned for a future release:
EndpointPurpose
GET /api/v1/objects/{type}List objects with pagination, search, and sorting
GET /api/v1/objects/{type}/{id}Retrieve a single object by ID
GET /api/v1/objects/{type}/schemaObject schema (properties, types, validation)
GET /api/v1/objects/{type}/actionsDiscover actions available for an object type

What You Can Do Today

Actions are fully available via the API right now. If you need to interact with objects, use actions:
  • Create — execute a collection-level action (e.g. create-order-action)
  • Update — execute an instance-level action (e.g. update-order-action)
  • Read — use the action schema discovery endpoint to understand object structure

Actions API

Execute actions, discover schemas, and run bulk operations — available now.

Client Credentials

Set up app-to-app authentication for your integration.