List surfaces | Runtype Documentation

curl https://api.runtype.com/v1/surfaces \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "surf_9f8b7c6d5e4a3b2c1d0e",
      "productId": "prod_1234567890abcdef",
      "name": "Slack Workspace Surface",
      "type": "slack",
      "inbound": {
        "integrationId": "intg_abcdef1234567890",
        "listenChannels": [
          "general",
          "random"
        ],
        "listenDms": false,
        "triggerOnMention": true,
        "continueThreads": true,
        "teamId": "T12345678",
        "teamName": "Acme Corp Slack",
        "appId": "A1B2C3D4E5"
      },
      "status": "active",
      "environment": "production",
      "createdAt": "2024-05-10T12:00:00Z",
      "updatedAt": "2024-06-01T08:30:00Z"
    }
  ],
  "pagination": {
    "nextCursor": "cursor_abcdef123456",
    "prevCursor": "cursor_123456abcdef",
    "hasMore": true,
    "hasPrev": false,
    "limit": 10,
    "currentOffset": 0,
    "totalPages": 5,
    "currentPage": 1,
    "totalCount": 45
  }
}

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

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

limitstringOptional

cursorstringOptional

typestringOptional

statusstringOptional

environmentstringOptional

Response

Paginated list of surfaces

datalist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/surfaces \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"data": [
3	{
4	"id": "surf_9f8b7c6d5e4a3b2c1d0e",
5	"productId": "prod_1234567890abcdef",
6	"name": "Slack Workspace Surface",
7	"type": "slack",
8	"inbound": {
9	"integrationId": "intg_abcdef1234567890",
10	"listenChannels": [
11	"general",
12	"random"
13	],
14	"listenDms": false,
15	"triggerOnMention": true,
16	"continueThreads": true,
17	"teamId": "T12345678",
18	"teamName": "Acme Corp Slack",
19	"appId": "A1B2C3D4E5"
20	},
21	"status": "active",
22	"environment": "production",
23	"createdAt": "2024-05-10T12:00:00Z",
24	"updatedAt": "2024-06-01T08:30:00Z"
25	}
26	],
27	"pagination": {
28	"nextCursor": "cursor_abcdef123456",
29	"prevCursor": "cursor_123456abcdef",
30	"hasMore": true,
31	"hasPrev": false,
32	"limit": 10,
33	"currentOffset": 0,
34	"totalPages": 5,
35	"currentPage": 1,
36	"totalCount": 45
37	}
38	}