List Folders - Cekura

List scenario folders

curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/scenarios/folders/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.cekura.ai/test_framework/v1/scenarios/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://api.cekura.ai/test_framework/v1/scenarios/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://api.cekura.ai/test_framework/v1/scenarios/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://api.cekura.ai/test_framework/v1/scenarios/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

{
  "count": 123,
  "results": [
    {
      "name": "<string>",
      "path": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "https://api.cekura.ai/example/v1/example-external/?page=4",
  "previous": "https://api.cekura.ai/example/v1/example-external/?page=3"
}

GET

/

test_framework

/

v1

/

scenarios

/

folders

/

List scenario folders

curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/scenarios/folders/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.cekura.ai/test_framework/v1/scenarios/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://api.cekura.ai/test_framework/v1/scenarios/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://api.cekura.ai/test_framework/v1/scenarios/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://api.cekura.ai/test_framework/v1/scenarios/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

{
  "count": 123,
  "results": [
    {
      "name": "<string>",
      "path": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "https://api.cekura.ai/example/v1/example-external/?page=4",
  "previous": "https://api.cekura.ai/example/v1/example-external/?page=3"
}

Authorizations

Authorization

string

header

required

OAuth access token issued by Cekura for connected apps.

Query Parameters

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

project_id

integer

required

Project ID to list folders for

parent_path

string

Parent folder path to get direct children only. Example: "Sales.Inbound"

search

string

Search folders by name (case-insensitive)

agent_id

integer

Tenant scope. Supply one of agent_id, project_id, assistant_id when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant.

assistant_id

string

Tenant scope. Supply one of agent_id, project_id, assistant_id when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant.

Response

200 - application/json

count

integer

required

Example:

123

results

object[]

required

Show child attributes

next

string<uri> | null

Example:

"https://api.cekura.ai/example/v1/example-external/?page=4"

previous

string<uri> | null

Example:

"https://api.cekura.ai/example/v1/example-external/?page=3"

⌘I