For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList surfaces
Dashboard
LogoLogo
Runtype APISurfaces

List surfaces

GET
/v1/surfaces
GET
/v1/surfaces
$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}

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.

Was this page helpful?
Previous

List client tokens

Next
Built with

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