Skip to main content
Version: 2021-07-28

Get Folders

GET 

/projects/spaces/:spaceId/folders

Pages folders under a space (folders[], not items). Simple: ?limit=20 then ?limit=20&cursor={nextCursor}. Deep-link: add anchorId of a known folder to load a window centered on it. Location comes from the token.

Request​

Version stringrequired

API Version

Available optionsv3
spaceId stringrequired

Space id

limit number

Maximum number of items per page

Possible values: >= 1 and <= 100

Default value:20
cursor string

Opaque base64-encoded position cursor for forward pagination

anchorId string

Optional. Center the page on this child (for example a list inside a long folder). When set, the response includes anchorId, anchorIndex, windowStart, and may include prevCursor / nextCursor. For simple forward paging, omit anchorId and use limit + cursor from nextCursor only.

application/json

Successful response

Schema
    foldersobject[]required

    Page of folders

    nextCursorstringnullable

    Cursor for the next page — pass back as cursor

    prevCursorstringnullable

    Cursor for the previous page (anchor windows only)

    anchorIdstringnullable

    Echoed when the request used anchorId

    anchorIndexnumber

    Index of the anchor folder in the window

    windowStartnumber

    Start offset of the current window