Create Folder

POST

folders

Create Folder

curl --request POST \
  --url https://public.api.serval.com/v2/folders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "parentFolderId": "<string>",
  "scopedId": "<string>"
}
'

import requests

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

payload = {
    "teamId": "<string>",
    "name": "<string>",
    "parentFolderId": "<string>",
    "scopedId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    teamId: '<string>',
    name: '<string>',
    parentFolderId: '<string>',
    scopedId: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'teamId' => '<string>',
    'name' => '<string>',
    'parentFolderId' => '<string>',
    'scopedId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"parentFolderId\": \"<string>\",\n  \"scopedId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/folders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"parentFolderId\": \"<string>\",\n  \"scopedId\": \"<string>\"\n}")
  .asString();

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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"parentFolderId\": \"<string>\",\n  \"scopedId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "itemType": "FOLDER_ITEM_TYPE_UNSPECIFIED",
    "parentFolderId": "<string>",
    "scopedId": "<string>"
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-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:write` Skill folder: `skills:write` Form folder: `settings:write`
Workspace-scoped API key	Workflow folder: `workflows:write` Skill folder: `skills:write` Form folder: `settings:write`
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. Workspace keys must allow every workspace 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.

Body

application/json

teamId

string

required

The ID of the workspace.

name

string

required

The name of the folder.

itemType

enum<string>

required

The non-folder item type this folder can contain. 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 | null

Optional parent folder. Unset creates the folder at the root. The parent must be of the same item_type.

scopedId

string | null

Portable identity: folder_ followed by 22 alphanumeric characters. Omit or leave empty to generate an ID; unique among live folders in the workspace.

Response

200 - application/json

Success

data

data · object

The created folder.

Show child attributes

Create Folder

curl --request POST \
  --url https://public.api.serval.com/v2/folders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "parentFolderId": "<string>",
  "scopedId": "<string>"
}
'

import requests

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

payload = {
    "teamId": "<string>",
    "name": "<string>",
    "parentFolderId": "<string>",
    "scopedId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    teamId: '<string>',
    name: '<string>',
    parentFolderId: '<string>',
    scopedId: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'teamId' => '<string>',
    'name' => '<string>',
    'parentFolderId' => '<string>',
    'scopedId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"parentFolderId\": \"<string>\",\n  \"scopedId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/folders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"parentFolderId\": \"<string>\",\n  \"scopedId\": \"<string>\"\n}")
  .asString();

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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"parentFolderId\": \"<string>\",\n  \"scopedId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "itemType": "FOLDER_ITEM_TYPE_UNSPECIFIED",
    "parentFolderId": "<string>",
    "scopedId": "<string>"
  }
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Body

Response