Skip to main content
GET
/
v1
/
surfaces
List Surface
curl --request GET \
  --url https://workflow.eu.confidence.dev/v1/surfaces \
  --header 'Authorization: Bearer <token>'
{
  "surfaces": [
    {
      "displayName": "<string>",
      "createTime": {},
      "updateTime": {},
      "deleteTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "description": "<string>",
      "labels": [
        {}
      ],
      "owner": "<string>",
      "reviews": {
        "mandatory": true,
        "reviewers": [
          "<string>"
        ]
      },
      "metricConfig": {
        "mandatoryMetrics": [
          {
            "metric": "<string>",
            "preferredDirection": "PREFERRED_DIRECTION_UNSPECIFIED",
            "successMetric": {
              "minimumDetectableEffect": {
                "value": "<string>"
              }
            },
            "guardrailMetric": {
              "nonInferiorityMargin": {
                "value": "<string>"
              }
            }
          }
        ],
        "associatedMetrics": [
          {
            "metric": "<string>"
          }
        ]
      },
      "automatedActions": [
        {
          "trigger": {
            "activityTrigger": {
              "kind": "<string>",
              "resource": "<string>"
            },
            "stateTrigger": {
              "state": "<string>",
              "resource": "<string>"
            }
          },
          "action": {
            "executeFunctionAction": {
              "function": "<string>",
              "parameters": {}
            },
            "pagerdutyAction": {
              "pdKey": "<string>",
              "severity": "critical",
              "title": "<string>",
              "description": "<string>"
            },
            "transitionAction": {
              "action": "<string>",
              "parameters": {}
            }
          }
        }
      ],
      "stakeholders": [
        {
          "identity": "<string>",
          "role": "<string>"
        }
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
pageSize
object

The maximum number of items to return.

​
pageToken
string

The next_page_token value returned from a previous List request, if any.

​
skip
object

The number of items to skip.

​
filter
string

Filter for surfaces, follows the lucene query string format.

​
showDeleted
boolean

If deleted surfaces should be included.

​
orderBy
string

Provide fields and direction to sort by. Will always tiebreak on name. Format: {"<"}field_0{">"}:{"<"}direction{">"}, {"<"}field_1{">"}:{"<"}direction{">"} Example: displayName:desc,createTime:asc

Response

200 - application/json

OK

​
surfaces
Surface · object[]

Surface: List of returned surfaces

​
nextPageToken
string

Token to retrieve the next page of results, or empty if there are no more results in the list.