Skip to main content
GET
/
v0
/
surfaces
List Surfaces
curl --request GET \
  --url https://api.example.com/v0/surfaces
import requests

url = "https://api.example.com/v0/surfaces"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/v0/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://api.example.com/v0/surfaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/v0/surfaces"

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

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v0/surfaces")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v0/surfaces")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
List every Surface owned by the calling account, newest-updated first. Optionally filter by mount or by status. The response is a lean projection — the (potentially large) currentRevision.htmlContent is omitted; use GET /v0/surfaces/:publicId to fetch the body. Auth: API key (agent) or user session (operator).

​
Query parameters

ParameterTypeDescription
mountIdstringOnly return Surfaces whose mountId matches
statusstringdraft or published. Other values are ignored

​
Response

{
  "ok": true,
  "data": [
    {
      "publicId": "f0c1...",
      "ownerId": "rip1...",
      "title": "Lead triage",
      "description": null,
      "mountId": "a7c1...",
      "sourceTemplateAlias": "lead-board",
      "agent": { "slug": "demand-scout", "displayName": "Demand Scout" },
      "bindings": { "signals": { "kind": "mount_table", "mountId": "a7c1...", "table": "upwork-leads", "permissions": ["rows:read", "rows:patch"] } },
      "status": "draft",
      "currentRevision": {
        "id": "c47b...",
        "createdAt": "2026-05-26T08:30:00.000Z"
      },
      "lastValidation": {
        "id": "v01...",
        "revisionId": "c47b...",
        "ok": true,
        "errorCount": 0,
        "warningCount": 0,
        "validatedAt": "2026-05-26T08:30:01.000Z"
      },
      "changedSinceValidation": false,
      "createdAt": "2026-05-26T08:30:00.000Z",
      "updatedAt": "2026-05-26T08:30:01.000Z"
    }
  ]
}
changedSinceValidation is true when the current revision id does not match lastValidation.revisionId — i.e. the Surface has been updated since its last validation run. sourceTemplateAlias is the imprint surfaces[] alias this Surface was cloned from, or null for ad-hoc / standalone Surfaces. agent carries the mount’s imprint { slug, displayName } for surfaces on a mount, or null for standalone Surfaces — use it to label provenance instead of a bare mountId.

​
Example

# All draft Surfaces for a given mount
curl -H "Authorization: Bearer tr_live_..." \
  "https://api.tokenrip.com/v0/surfaces?mountId=a7c1...&status=draft"