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 conversations
      • POSTCreate conversation
      • GETGet conversation
      • PUTUpdate conversation
      • DELDelete conversation
      • GETList messages
      • POSTCreate message
Dashboard
LogoLogo
Runtype APIMessaging Conversations

List conversations

GET
/v1/messaging/conversations
GET
/v1/messaging/conversations
$curl https://api.runtype.com/v1/messaging/conversations \
> -H "Authorization: <apiKey>" \
> -H "Content-Type: application/json"
1{
2 "data": [
3 {
4 "createdAt": "2024-06-10T09:15:00Z",
5 "externalParticipantId": "user_987654321",
6 "externalThreadId": "thread_123456789",
7 "id": "conv_abc123def456",
8 "lastMessageAt": "2024-06-12T14:45:00Z",
9 "messageCount": 42,
10 "participantEmail": "jane.doe@example.com",
11 "participantName": "Jane Doe",
12 "status": "open",
13 "subject": "Project Update Discussion",
14 "surfaceId": "surface_001",
15 "timezone": "America/New_York",
16 "updatedAt": "2024-06-12T14:50:00Z"
17 }
18 ],
19 "pagination": {
20 "currentOffset": 0,
21 "hasMore": true,
22 "hasPrev": false,
23 "limit": 50,
24 "nextCursor": "cursor_abcdef123456",
25 "prevCursor": null,
26 "currentPage": 1,
27 "totalCount": 120,
28 "totalPages": 3
29 }
30}
Get all messaging conversations for the authenticated user with filtering and pagination.
Was this page helpful?
Previous

Create conversation

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Query parameters

limitstringOptional

Max results per page (default 50, max 100)

cursorstringOptional
Pagination cursor
surfaceIdstringOptional
Filter by surface ID
statusstringOptional

Filter by status (open, closed, archived, all)

searchstringOptional
Search by subject, participant name, or email

Response

Paginated list of conversations
datalist of objects
paginationobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error