Collections

curl -X GET "/v1/collections"

Run the request to inspect the response.

curl -X POST "/v1/collections" -H "Content-Type: application/json" -d '{
  "url": "https://example.com"
}'

Run the request to inspect the response.

curl -X GET "/v1/collections/{id}"

Run the request to inspect the response.

curl -X PATCH "/v1/collections/{id}" -H "Content-Type: application/json" -d '{
  "url": "https://example.com"
}'

Run the request to inspect the response.

curl -X DELETE "/v1/collections/{id}"

Run the request to inspect the response.

curl -X GET "/v1/collections/count"

Run the request to inspect the response.

A Collection is a workspace-level grouping of Pages. Use them to organize captures by product, brand, or any other taxonomy that fits.

Endpoints

Method	Path	Scope
GET	/v1/collections	collections.read
POST	/v1/collections	collections.write
GET	/v1/collections/{id}	collections.read
PATCH	/v1/collections/{id}	collections.write
DELETE	/v1/collections/{id}	collections.write
GET	/v1/collections/count	collections.read

Linking a page to a collection

POST /v1/moments accepts a collectionId field. The new Page will be linked to that collection at creation time. To change the link later, use the dedicated collections endpoints.

Spec

The full request and response shapes are in the OpenAPI spec at /api/v1/openapi — see the Collections tag.