Type Alias CollectionsAPI

Index

Properties

addCollectionItem: typeof addCollectionItem

Adds an item to a collection and returns the item.

The collection's unique identifier.

an object with the body content

AddCollectionItemHttpError

clearCache: typeof clearCache

Clears the cache for collections api requests.

createCollection: typeof createCollection

Creates and returns a new collection. Collections of type public (shown as tags in the user interface) must have unique names. Other collection types can reuse names.

an object with the body content

CreateCollectionHttpError

deleteCollection: typeof deleteCollection

Deletes a collection and removes all items from the collection.

The collection's unique identifier.

DeleteCollectionHttpError

deleteCollectionItem: typeof deleteCollectionItem

Removes an item from a collection.

The collection's unique identifier.

The item's unique identifier.

DeleteCollectionItemHttpError

getCollection: typeof getCollection

Finds and returns a collection.

The collection's unique identifier.

GetCollectionHttpError

getCollectionItem: typeof getCollectionItem

Finds and returns an item in a specific collection. See GET /items/{id}.

The collection's unique identifier.

The item's unique identifier.

GetCollectionItemHttpError

getCollectionItems: typeof getCollectionItems

Retrieves items from a collection that the user has access to.

The collection's unique identifier. (This query also supports 'favorites' as the collectionID). *

an object with query parameters

GetCollectionItemsHttpError

getCollections: typeof getCollections

Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with /v1/collections/favorites.

an object with query parameters

GetCollectionsHttpError

getFavoritesCollection: typeof getFavoritesCollection

Lists the user's favorites collection.

GetFavoritesCollectionHttpError

patchCollection: typeof patchCollection

Updates the name, description, or type fields provided in the patch body. Can be used to publish a private collection as a publicgoverned collection by patching /type with publicgoverned once the collection contains at least 1 item. Can also be used to return a publicgoverned collection to private. Cannot be used to change between public (tag) and private / publicgoverned (collection).

The collection's unique identifier.

an object with the body content

PatchCollectionHttpError

updateCollection: typeof updateCollection

Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.

The collection's unique identifier.

an object with the body content

UpdateCollectionHttpError