Get instance app surface settings

GET

/api/v1/admin/apps/surfaces

const url = 'https://example.com/api/v1/admin/apps/surfaces';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/admin/apps/surfaces \
  --header 'Authorization: Bearer <token>'

Returns the instance app surface settings. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/admin/apps/surfaces. Inputs: . Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Responses

200

application/json

Array<object>

object

effective_enabled

required

boolean

instance_enabled

required

boolean

surface

required

These gates protect external automation credentials. Browser sessions remain usable so a User can always restore their own access in Settings.

string

Allowed values: notes api cli mcp mcp_events webmcp

user_enabled

required

boolean

Example

[
  {
    "surface": "notes"
  }
]