• Features
  • Pricing
Get Started

List CollectionsCreate CollectionGet CollectionUpdate CollectionDelete Collection

POST /v1/collections

Create a new collection by sending a JSON request body.

POST /v1/collections creates a new collection.

Authentication

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

Request Body

name is required. All other fields are optional.

NameTypeRequiredDescription
namestringYesCollection name, from 1 to 100 characters.
descriptionstring or nullNoDescription, up to 4,000 characters.
teamIdsarray of stringsNoUp to 100 teams allowed to access the collection. Defaults to an empty array.
isPubliclyVisiblebooleanNoWhether the collection is visible on the public website. Defaults to false.

Example

curl -X POST "https://api.blueputto.com/v1/collections" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"name":"Sculpture collection","isPubliclyVisible":true}'

Success Response

201 Created

{
  "data": {}
}

Error Responses

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

GET /v1/collections

List collections with pagination and free-text search.

GET /v1/collections/{collectionId}

Retrieve a single collection by its UUID.

On this page

AuthenticationRequest BodyExampleSuccess ResponseError Responses