> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# List surfaces

GET https://api.runtype.com/v1/surfaces

List product surfaces across the authenticated user/org's products with cursor-based pagination. Supports filtering by product, type, and status. Slack inbound config is returned only for Slack surfaces and only includes safe-to-expose keys.

Reference: https://docs.runtype.com/api-reference/runtype-api/surfaces/list-surfaces

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Query parameters

- `limit` (string, optional)
- `cursor` (string, optional)
- `productId` (string, optional)
- `type` (string, optional)
- `status` (string, optional)

## Response

### 200

Paginated list of surfaces

- `data` (list of V1SurfacesGetResponsesContentApplicationJsonSchemaDataItems, required)
- `pagination` (Pagination, required)

## Errors

### 400 Bad Request Error

Invalid parameters

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `code` (string, required) — Stable error code: `INTERNAL_ERROR` unless the route documents its own.
- `error` (string, required)
- `details` (list of InternalErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.
- `message` (string, optional) — Plain-language guidance: retry, then contact support with the `requestId`.
- `requestId` (string, optional) — The `X-Runtype-Request-ID` of the failed request, for support.

### 503 Service Unavailable Error

Database temporarily unavailable; nothing was read or written. Retry after the `Retry-After` interval (seconds).

- `code` (enum, required) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
  - Allowed values: `DATABASE_UNAVAILABLE`
- `error` (string, required)
- `details` (list of DatabaseUnavailableErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.
- `requestId` (string, optional) — The `X-Runtype-Request-ID` of the failed request, for support.

## Types

### V1SurfacesGetResponsesContentApplicationJsonSchemaDataItems

- `createdAt` (string, required)
- `endpoint` (string, required, nullable) — Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves.
- `id` (string, required)
- `inbound` (V1SurfacesGetResponsesContentApplicationJsonSchemaDataItemsInbound, required, nullable)
- `name` (string, required)
- `productId` (string, required)
- `productName` (string, required) — Name of the product this surface belongs to. Non-nullable: the list query inner-joins products (so a surface with no product cannot appear) and products.name is NOT NULL. Present so a cross-product picker can disambiguate two surfaces that share a name.
- `status` (string, required)
- `type` (string, required)
- `updatedAt` (string, required)
- `webhookHealth` (WebhookHealth, required)

### Pagination

- `currentOffset` (integer, required)
- `hasMore` (boolean, required)
- `hasPrev` (boolean, required)
- `limit` (integer, required)
- `nextCursor` (string, required, nullable)
- `prevCursor` (string, required, nullable)
- `currentPage` (integer, optional)
- `totalCount` (integer, optional)
- `totalPages` (integer, optional)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### InternalErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### DatabaseUnavailableErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1SurfacesGetResponsesContentApplicationJsonSchemaDataItemsInbound

- `appId` (string, optional)
- `channelOverrides` (map from string to V1SurfacesGetResponsesContentApplicationJsonSchemaDataItemsInboundChannelOverrides, optional) — Per-channel channelResponseMode and eagerness, keyed by channel ID.
- `channelResponseMode` (enum, optional) — When the bot answers an unmentioned channel message: mention (default for new surfaces), always, or judge (asks the platform response-gate judgment whether to reply; a failed judgment waits for a mention).
  - Allowed values: `mention`, `judge`, `always`
- `contextBackfill` (V1SurfacesGetResponsesContentApplicationJsonSchemaDataItemsInboundContextBackfill, optional) — How skipped channel messages reach the conversation when the bot answers: window (default) adds up to maxMessages (default and ceiling 20) from the last maxAgeMinutes (default 360, ceiling 1440) as context; judged adds, within the same bounds, only the messages the platform response-gate judgment finds needed to understand the answered message, and falls back to window when the judgment fails; none adds nothing.
- `continueThreads` (boolean, optional)
- `eagerness` (enum, optional) — How readily judge mode replies: conservative, balanced (default) or eager. Each selects a pair of reply and silence thresholds.
  - Allowed values: `conservative`, `balanced`, `eager`
- `integrationId` (string, optional)
- `keywords` (V1SurfacesGetResponsesContentApplicationJsonSchemaDataItemsInboundKeywords, optional) — Whole-word, case-insensitive filter on unmentioned messages in always and judge mode; judge mode applies it before the judgment.
- `listenChannels` (list of string, optional)
- `listenDms` (boolean, optional)
- `onUncertain` (enum, optional) — What judge mode does when the judgment lands between the two thresholds: silent (default) or reply.
  - Allowed values: `silent`, `reply`
- `responseGateShadow` (boolean, optional) — Opt-in. In mention or always mode, also judge each unmentioned channel message and record the decision and probability without changing what the bot does.
- `responseRules` (string, optional) — Free text (up to 2000 characters) the judge-mode judgment reads as the rules for when the bot should speak, for example "answer questions about resetting Acme account passwords".
- `teamId` (string, optional)
- `teamName` (string, optional)
- `triggerOnMention` (boolean, optional, deprecated) — Deprecated; use channelResponseMode. true reads as mention, false as always.

### WebhookHealth

- `lastDeliveryAt` (string, required, nullable) — ISO timestamp of the most recent accepted inbound delivery.
- `recentFailures` (list of WebhookHealthRecentFailuresItems, required) — Most recent inbound rejections, newest first, capped at a small fixed number. A failure newer than lastDeliveryAt means the webhook is currently rejecting events (commonly a credential mismatch such as a wrong Slack signing secret).

### V1SurfacesGetResponsesContentApplicationJsonSchemaDataItemsInboundChannelOverrides

- `channelResponseMode` (enum, optional)
  - Allowed values: `mention`, `judge`, `always`
- `eagerness` (enum, optional)
  - Allowed values: `conservative`, `balanced`, `eager`

### V1SurfacesGetResponsesContentApplicationJsonSchemaDataItemsInboundContextBackfill

How skipped channel messages reach the conversation when the bot answers: window (default) adds up to maxMessages (default and ceiling 20) from the last maxAgeMinutes (default 360, ceiling 1440) as context; judged adds, within the same bounds, only the messages the platform response-gate judgment finds needed to understand the answered message, and falls back to window when the judgment fails; none adds nothing.

- `maxAgeMinutes` (integer, optional)
- `maxMessages` (integer, optional)
- `mode` (enum, optional)
  - Allowed values: `judged`, `window`, `none`

### V1SurfacesGetResponsesContentApplicationJsonSchemaDataItemsInboundKeywords

Whole-word, case-insensitive filter on unmentioned messages in always and judge mode; judge mode applies it before the judgment.

- `ignore` (list of string, optional)
- `require` (list of string, optional)

### WebhookHealthRecentFailuresItems

- `at` (string, required)
- `reason` (string, required)
- `statusCode` (double, optional)

## Examples

**Response**

```json
{
  "data": [
    {
      "createdAt": "string",
      "endpoint": "string",
      "id": "string",
      "inbound": {
        "appId": "string",
        "channelOverrides": {},
        "channelResponseMode": "mention",
        "contextBackfill": {
          "maxAgeMinutes": 1,
          "maxMessages": 1,
          "mode": "judged"
        },
        "continueThreads": true,
        "eagerness": "conservative",
        "integrationId": "string",
        "keywords": {
          "ignore": [
            "string"
          ],
          "require": [
            "string"
          ]
        },
        "listenChannels": [
          "string"
        ],
        "listenDms": true,
        "onUncertain": "silent",
        "responseGateShadow": true,
        "responseRules": "string",
        "teamId": "string",
        "teamName": "string",
        "triggerOnMention": true
      },
      "name": "string",
      "productId": "string",
      "productName": "string",
      "status": "string",
      "type": "string",
      "updatedAt": "string",
      "webhookHealth": {
        "lastDeliveryAt": "string",
        "recentFailures": [
          {
            "at": "string",
            "reason": "string",
            "statusCode": 1.1
          }
        ]
      }
    }
  ],
  "pagination": {
    "currentOffset": 1,
    "hasMore": true,
    "hasPrev": true,
    "limit": 1,
    "nextCursor": "string",
    "prevCursor": "string",
    "currentPage": 1,
    "totalCount": 1,
    "totalPages": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/surfaces"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/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);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/surfaces"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/surfaces")

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

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

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.runtype.com/v1/surfaces")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.runtype.com/v1/surfaces', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/surfaces");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/surfaces")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```