List Folders - Serval Documentation

GET

folders

List Folders

curl --request GET \
  --url https://public.api.serval.com/v2/folders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/folders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/folders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/folders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/folders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "teamId": "<string>",
      "name": "<string>",
      "itemType": "FOLDER_ITEM_TYPE_UNSPECIFIED",
      "parentFolderId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	Workflow folder: `workflows:read` Skill folder: `skills:read` Form folder: `settings:read`
Team-scoped API key	Workflow folder: `workflows:read` Skill folder: `skills:read` Form folder: `settings:read`
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

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,

FOLDER_ITEM_TYPE_FORM

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

200 - application/json

Success

data

Folder · object[]

The folders. Use parent_folder_id to reconstruct the tree.

Show child attributes

nextPageToken

string | null

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

List Folders

curl --request GET \
  --url https://public.api.serval.com/v2/folders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/folders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/folders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/folders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/folders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "teamId": "<string>",
      "name": "<string>",
      "itemType": "FOLDER_ITEM_TYPE_UNSPECIFIED",
      "parentFolderId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

​Authentication and permissions

Authorizations

Query Parameters

Response

Authentication and permissions