Skip to main content
GET
/
v2
/
folders
List Folders
curl --request GET \
  --url https://public.api.serval.com/v2/folders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "teamId": "<string>",
      "name": "<string>",
      "parentFolderId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
teamId
string
required

The ID of the team.

​
itemType
enum<string>
required

The non-folder item type of folders to list. Required — folders are scoped per type, and FOLDER_ITEM_TYPE_UNSPECIFIED and FOLDER_ITEM_TYPE_FOLDER are rejected.

Available options:
FOLDER_ITEM_TYPE_UNSPECIFIED,
FOLDER_ITEM_TYPE_FOLDER,
FOLDER_ITEM_TYPE_WORKFLOW,
FOLDER_ITEM_TYPE_GUIDANCE
​
parentFolderId
string

Optional. When set, return only the direct children of this folder. When unset, return all folders of the given type for the team (a flat list; use parent_folder_id to reconstruct the tree).

​
pageSize
integer<int32>

Maximum number of results to return. Default is 1000, maximum is 2000. When neither page_size nor page_token is set, all results are returned.

​
pageToken
string

Token for pagination. Leave empty for the first request.

Response

Success

​
data
Folder · object[]

The folders. Use parent_folder_id to reconstruct the tree.

​
nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results.