API Reference
List Surface
GET
/
v1
/
surfaces
List Surface
curl --request GET \
--url https://workflow.eu.confidence.dev/v1/surfaces \
--header 'Authorization: Bearer <token>'import requests
url = "https://workflow.eu.confidence.dev/v1/surfaces"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://workflow.eu.confidence.dev/v1/surfaces', 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://workflow.eu.confidence.dev/v1/surfaces",
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://workflow.eu.confidence.dev/v1/surfaces"
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))
}HttpResponse<String> response = Unirest.get("https://workflow.eu.confidence.dev/v1/surfaces")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://workflow.eu.confidence.dev/v1/surfaces")
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{
"surfaces": [
{
"displayName": "<string>",
"createTime": {},
"updateTime": {},
"creator": "<string>",
"updater": "<string>",
"name": "<string>",
"description": "<string>",
"labels": [
{}
],
"deleteTime": {},
"owner": "<string>",
"reviews": {
"mandatory": true,
"reviewers": [
"<string>"
]
},
"metricConfig": {
"mandatoryMetrics": [
{
"metric": "<string>",
"successMetric": {
"minimumDetectableEffect": {
"value": "<string>"
}
},
"guardrailMetric": {
"nonInferiorityMargin": {
"value": "<string>"
}
}
}
],
"associatedMetrics": [
{
"metric": "<string>",
"successMetric": {
"minimumDetectableEffect": {
"value": "<string>"
}
},
"guardrailMetric": {
"nonInferiorityMargin": {
"value": "<string>"
}
}
}
],
"metrics": [
{
"metric": "<string>",
"successMetric": {
"minimumDetectableEffect": {
"value": "<string>"
}
},
"guardrailMetric": {
"nonInferiorityMargin": {
"value": "<string>"
}
}
}
]
},
"automatedActions": [
{
"trigger": {
"activityTrigger": {
"kind": "<string>",
"resource": "<string>"
},
"stateTrigger": {
"state": "<string>",
"resource": "<string>"
}
},
"action": {
"executeFunctionAction": {
"function": "<string>",
"parameters": {}
},
"pagerdutyAction": {
"pdKey": "<string>",
"title": "<string>",
"description": "<string>"
},
"transitionAction": {
"action": "<string>",
"parameters": {}
}
}
}
],
"stakeholders": [
{
"identity": "<string>",
"role": "<string>"
}
]
}
],
"nextPageToken": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The maximum number of items to return.
The next_page_token value returned from a previous List request, if any.
The number of items to skip.
Filter for surfaces, follows the lucene query string format.
If deleted surfaces should be included.
Provide fields and direction to sort by. Will always tiebreak on name. Format: {"<"}field_0{">"}:{"<"}direction{">"}, {"<"}field_1{">"}:{"<"}direction{">"} Example: displayName:desc,createTime:asc
Was this page helpful?
⌘I
List Surface
curl --request GET \
--url https://workflow.eu.confidence.dev/v1/surfaces \
--header 'Authorization: Bearer <token>'import requests
url = "https://workflow.eu.confidence.dev/v1/surfaces"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://workflow.eu.confidence.dev/v1/surfaces', 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://workflow.eu.confidence.dev/v1/surfaces",
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://workflow.eu.confidence.dev/v1/surfaces"
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))
}HttpResponse<String> response = Unirest.get("https://workflow.eu.confidence.dev/v1/surfaces")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://workflow.eu.confidence.dev/v1/surfaces")
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{
"surfaces": [
{
"displayName": "<string>",
"createTime": {},
"updateTime": {},
"creator": "<string>",
"updater": "<string>",
"name": "<string>",
"description": "<string>",
"labels": [
{}
],
"deleteTime": {},
"owner": "<string>",
"reviews": {
"mandatory": true,
"reviewers": [
"<string>"
]
},
"metricConfig": {
"mandatoryMetrics": [
{
"metric": "<string>",
"successMetric": {
"minimumDetectableEffect": {
"value": "<string>"
}
},
"guardrailMetric": {
"nonInferiorityMargin": {
"value": "<string>"
}
}
}
],
"associatedMetrics": [
{
"metric": "<string>",
"successMetric": {
"minimumDetectableEffect": {
"value": "<string>"
}
},
"guardrailMetric": {
"nonInferiorityMargin": {
"value": "<string>"
}
}
}
],
"metrics": [
{
"metric": "<string>",
"successMetric": {
"minimumDetectableEffect": {
"value": "<string>"
}
},
"guardrailMetric": {
"nonInferiorityMargin": {
"value": "<string>"
}
}
}
]
},
"automatedActions": [
{
"trigger": {
"activityTrigger": {
"kind": "<string>",
"resource": "<string>"
},
"stateTrigger": {
"state": "<string>",
"resource": "<string>"
}
},
"action": {
"executeFunctionAction": {
"function": "<string>",
"parameters": {}
},
"pagerdutyAction": {
"pdKey": "<string>",
"title": "<string>",
"description": "<string>"
},
"transitionAction": {
"action": "<string>",
"parameters": {}
}
}
}
],
"stakeholders": [
{
"identity": "<string>",
"role": "<string>"
}
]
}
],
"nextPageToken": "<string>"
}
