• Features
  • Pricing
Get Started

List ObjectsCreate ObjectGet ObjectUpdate ObjectTrash ObjectRestore ObjectDelete Permanently

POST /v1/objects

Create a new object by sending a JSON request body.

POST /v1/objects creates a new object.

Authentication

Send an organization API key in x-api-key or Authorization: Bearer <key>.

Request Body

Send a JSON object with the target collection and design. name is optional and can be null.

NameTypeRequiredDescription
collectionIdstring (uuid)YesUUID of the collection that owns the object.
designIdstring (uuid)YesUUID of the design used by the object.
namestring or nullNoInitial object name.

Example

curl -X POST "https://api.blueputto.com/v1/objects" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"collectionId":"COLLECTION_ID","designId":"DESIGN_ID","name":"Chair"}'

Success Response

201 Created

{
  "data": {}
}

Error Responses

  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 429 Too Many Requests

GET /v1/objects

List objects with pagination, free-text search, and an optional trash-only filter.

GET /v1/objects/{objectId}

Retrieve a single object by its UUID.

On this page

AuthenticationRequest BodyExampleSuccess ResponseError Responses