Get a feed of your collections

Home

Get a feed of your collections

Get a feed that lists file collections to which you have access. This returns a feed of the file collections to which you have access.

Atom API request details

Resource Description
/basic/api/collections/feed A feed of all file collections that are visible to the authenticated user. You must authenticate this request.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Input parameters

Parameter Description
access Filters the returns by the access role of the authenticated user. Options are:

editor
manager

You can use this parameter with an authenticated request only.
creator User ID. Specifies to return only file collections created by the user specified by the user ID.
page Page number. Specifies the page to be returned. The default value is 1.
pageSize Page size. Specifies the number of entries to be returned per page.
shared Filters the list of results based on whether the collection is shared or not. Options are true, false, or null. Passing null returns all content, regardless of whether it is shared. If visibility is public, then this parameter is ignored.
sharedWithMe Filters the list of results based on whether the authenticated user was added to the collection and assigned to a specific role, and did not create the collection. Options are true or false. Defaults to false.
sI Start index. Specifies the start index (number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
sortBy String. Specifies what to sort the returned entries by. Options are:

itemCount

Organize the entries by the number of files associated with it.

published

Organize the entries by the collection creation date.

title

Organize the entries by title. The title is specified in the <title> element of the entry.

updated

Organize the entries by last time the collection as modified.

The default option is title.
sortOrder Defines the order in which to sort the results. Options are:

asc

Ascending.

desc

Descending. This value is the default value.

Defaults to asc.
title String. Specifies the title of the collection to return.
visibility Filters the list of results based on the target of the share. Options are public, private, and null. The default is null, which returns both the public collections, and the private collections to which you have access.

Get Files feeds

+
Search Tips | Advanced Search

Parameter	Description
access	Filters the returns by the access role of the authenticated user. Options are: editor manager You can use this parameter with an authenticated request only.
creator	User ID. Specifies to return only file collections created by the user specified by the user ID.
page	Page number. Specifies the page to be returned. The default value is 1.
pageSize	Page size. Specifies the number of entries to be returned per page.
shared	Filters the list of results based on whether the collection is shared or not. Options are true, false, or null. Passing null returns all content, regardless of whether it is shared. If visibility is public, then this parameter is ignored.
sharedWithMe	Filters the list of results based on whether the authenticated user was added to the collection and assigned to a specific role, and did not create the collection. Options are true or false. Defaults to false.
sI	Start index. Specifies the start index (number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
sortBy	String. Specifies what to sort the returned entries by. Options are: itemCount Organize the entries by the number of files associated with it. published Organize the entries by the collection creation date. title Organize the entries by title. The title is specified in the <title> element of the entry. updated Organize the entries by last time the collection as modified. The default option is title.
sortOrder	Defines the order in which to sort the results. Options are: asc Ascending. desc Descending. This value is the default value. Defaults to asc.
title	String. Specifies the title of the collection to return.
visibility	Filters the list of results based on the target of the share. Options are public, private, and null. The default is null, which returns both the public collections, and the private collections to which you have access.