Skip to main content
GET
/
v0
/
surfaces
/
{publicId}
Get Surface
curl --request GET \
  --url https://api.example.com/v0/surfaces/{publicId}
import requests

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

response = requests.get(url)

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

fetch('https://api.example.com/v0/surfaces/{publicId}', 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/{publicId}",
  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/{publicId}"

	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/{publicId}")
  .asString();
require 'uri'
require 'net/http'

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

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
Get the full detail for a single Surface, including the current revision’s htmlContent. Use this to read back the source before issuing an update. Auth: API key (agent) or user session (operator). Owner-only.

Path parameters

ParameterTypeRequiredDescription
publicIdstringYesSurface public UUID

Response

Same shape as list-surfaces but currentRevision includes the full HTML:
{
  "ok": true,
  "data": {
    "publicId": "f0c1...",
    "ownerId": "rip1...",
    "title": "Lead triage",
    "description": null,
    "mountId": "a7c1...",
    "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",
      "htmlContent": "<!doctype html><html>…</html>"
    },
    "lastValidation": { /* SurfaceValidationSummary */ },
    "changedSinceValidation": false,
    "createdAt": "2026-05-26T08:30:00.000Z",
    "updatedAt": "2026-05-26T08:30:01.000Z"
  }
}

Errors

StatusCodeCause
404SURFACE_NOT_FOUNDNo Surface with that public id is owned by the caller (existence is not leaked to non-owners)

See also

The Surface lifecycle exposes several other read endpoints not documented as separate pages:
  • GET /v0/surfaces/:publicId/events — last 200 SDK + runtime telemetry events for a Surface (owner-only).
  • GET /v0/surfaces/:publicId/validations — last 10 validation rows with screenshot keys + counts (owner-only).
  • GET /v0/surfaces/:publicId/validations/:validationId/screenshot/:variant — stream a validation screenshot (desktop or mobile, owner-only).
  • POST /v0/surfaces/:publicId/events — public telemetry ingress; the browser-side surface-instrument.js shim posts here from operator sessions. Soft-fails on unknown Surface to avoid existence oracles.