Collaboration#

Share a collection#

POST /collections/{collection_id}/users/share

Share a collection with a user.

URL parameters#

  • collection_id: The ID of the collection.

Request#

The request body should be an object with the following properties:

  • email: The email of the user to share the collection with.

Response#

An object with the following properties:

  • action: The action of the sharing. It will always be share.

  • collection_id: The ID of the collection.

  • user: The user object of the user to share the collection with. It contains the following properties:

    • id: The ID of the user.

    • name: The name of the user.

    • email: The email of the user.

Unshare a collection#

POST /collections/{collection_id}/users/unshare

Unshare a collection with a user.

URL parameters#

  • collection_id: The ID of the collection.

Request#

The request body should be an object with the following properties:

  • email: The email of the user to unshare the collection with.

Response#

An object with the following properties:

  • action: The action of the sharing. It will always be unshare.

  • collection_id: The ID of the collection.

  • user: The user object of the user to unshare the collection with. It contains the following properties:

    • id: The ID of the user.

    • name: The name of the user.

    • email: The email of the user.

Get all shared users of a collection#

GET /collections/{collection_id}/users

Get all users who the collection is shared with.

URL parameters#

  • collection_id: The ID of the collection.

Response#

An array of user objects.