v1

latestOpenAPI 3.0.12026-07-2471156164.1 KB

Folders

List folders

Returns all undeleted folders the current user has access to. A maximum of 110 folders will be returned. If more than 110 folders exist, a link to the next page of results will be included in the Link header

get/api/v1/folders

Query parameters

tokenstring

Paging token

sortField'title' | 'lastModified'

Sort Field

sortOrder'ASC' | 'DESC'

Sort Order

qstring

Query

searchstring

Search Term

collectionstring

Collection

folderIdsstring

A comma-separated list of Folder IDs

legacyTypesstring

A comma-separated list of Folder Legacy Types to filter by: BOARD_GROUP, BOARD or SECTION

Response

successful operation

homeboolean

Indicates if this folder is the top level folder for the collection

idstring

The ID of the directory

lastModifiedstring date-time

The date that the directory was last modified

groupsSharedWithstring[]

Returns the groups that a directory is shared with

slugstring

The slug is the URL address to the directory

numberOfFactsinteger

The number of cards in the directory

favoritedDatestring date-time

When this directory has been favorited by the current user

favoritedboolean

Whether this board has been favorited by the current user

descriptionstring

An optional short description of the directory

titlestring

The title of the directory