Get a SurfaceScope

curl --request GET \
  --url https://api.checkfu.com/v1/surface-scopes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/surface-scopes/{id}"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.checkfu.com/v1/surface-scopes/{id}', 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.checkfu.com/v1/surface-scopes/{id}",
  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>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/surface-scopes/{id}"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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://api.checkfu.com/v1/surface-scopes/{id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/surface-scopes/{id}")

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "external_installation_id": "<string>",
  "external_id": "<string>",
  "visibility": "public",
  "membership": "public",
  "inheritance": "inherit",
  "display_name": "<string>",
  "state": "active",
  "version": 1,
  "created_at": "<string>",
  "updated_at": "<string>",
  "kind": "root",
  "parent_id": null,
  "verified_member": {
    "principal_id": "<string>",
    "external_identity_link_id": "<string>",
    "paired_at": "<string>"
  },
  "membership_assertion": {
    "asserted_at": "<string>",
    "freshness_horizon_seconds": 43230
  },
  "ambient_policy": {
    "enabled": true,
    "muted": true,
    "max_responses_per_window": 1,
    "max_tokens_per_window": 1,
    "self_quiet_threshold": 1
  }
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Get a SurfaceScope

Returns one SurfaceScope with its kind, parent_id, external_id, governance classification (visibility, membership, inheritance), lifecycle state, and version. A thread is not a SurfaceScope: threads map to Sessions through a ConversationBinding, and the scope is the channel they live in.

Checkfu support posture: alpha; hosted. Required evidence journey: collaboration-identity. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

GET

surface-scopes

{id}

Get a SurfaceScope

curl --request GET \
  --url https://api.checkfu.com/v1/surface-scopes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/surface-scopes/{id}"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.checkfu.com/v1/surface-scopes/{id}', 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.checkfu.com/v1/surface-scopes/{id}",
  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>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/surface-scopes/{id}"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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://api.checkfu.com/v1/surface-scopes/{id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/surface-scopes/{id}")

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "external_installation_id": "<string>",
  "external_id": "<string>",
  "visibility": "public",
  "membership": "public",
  "inheritance": "inherit",
  "display_name": "<string>",
  "state": "active",
  "version": 1,
  "created_at": "<string>",
  "updated_at": "<string>",
  "kind": "root",
  "parent_id": null,
  "verified_member": {
    "principal_id": "<string>",
    "external_identity_link_id": "<string>",
    "paired_at": "<string>"
  },
  "membership_assertion": {
    "asserted_at": "<string>",
    "freshness_horizon_seconds": 43230
  },
  "ambient_policy": {
    "enabled": true,
    "muted": true,
    "max_responses_per_window": 1,
    "max_tokens_per_window": 1,
    "self_quiet_threshold": 1
  }
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-27

Path Parameters

string

required

Pattern: ^surf_[0-9a-f]{32}$

Response

Success

Option 1
Option 2

string

required

Pattern: ^surf_[0-9a-f]{32}$

workspace_id

string

required

Pattern: ^wrkspc_[0-9a-f]{32}$

external_installation_id

string

required

Pattern: ^exti_[0-9a-f]{32}$

external_id

string

required

Required string length: 1 - 512

visibility

enum<string>

required

Available options:

public,

private,

personal

membership

enum<string>

required

Available options:

public,

provider_members,

personal

inheritance

enum<string>

required

Available options:

inherit,

isolate

display_name

string | null

required

Required string length: 1 - 255

state

enum<string>

required

Available options:

active,

disabled,

disconnected,

archived

version

integer

required

Required range: x > 0

created_at

string

required

updated_at

string

required

kind

enum<string>

required

Available options:

root

parent_id

null

required

verified_member

object

Show child attributes

membership_assertion

object

Show child attributes

ambient_policy

object

Show child attributes

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Get a SurfaceScope

Authorizations

Headers

Path Parameters

Response