Skip to content

Collection

Create and Delete

A "Default" collection is automatically created for each user. If you want your client to support collection creation and deletion:

POST /collections

Scalar - Swagger

DELETE /collections/{col_id}

Scalar - Swagger

Fetch

Required

To get all collections owned by the user, list them with:

GET /collections

Scalar - Swagger

It returns a list of CollectionView.

UI suggestion

You may want to add a section where you format and display these to the user, so they can act on them (select, rename, delete, ...).

Once the user selects a collection, cache its ID — you'll need it for most subsequent queries.

Update

To update a collection (name, settings, ...), use:

PATCH /collections/{col_id}

Scalar - Swagger

See Update Resources Page for more details.


Once the user has selected a collection, it's time to fetch the nodes associated with it.