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
  • Runtype API
      • GETList flows
      • POSTCreate flow
      • GETGet flow details
      • PUTUpdate flow
      • DELDelete flow
      • GETList flow step results
      • POSTPublish flow
      • POSTRun flow on records of a type
      • GETExport flow for runtime
Dashboard
LogoLogo
Runtype APIFlows

List flows

GET
/v1/flows
GET
/v1/flows
$curl https://api.runtype.com/v1/flows \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json"
1{
2 "data": [
3 {
4 "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
5 "name": "Weekly Newsletter Automation",
6 "status": "active",
7 "createdAt": "2024-05-10T09:15:00Z",
8 "updatedAt": "2024-06-01T12:00:00Z",
9 "lastRunAt": "2024-06-05T08:30:00Z"
10 }
11 ],
12 "pagination": {
13 "nextCursor": "eyJpZCI6IjY3ODkwYWJjZC1lZjEyLTM0NTYtYmY3OC1hYmNkZWYxMjM0NTYifQ==",
14 "prevCursor": "eyJpZCI6IjEyMzQ1Njc4OS1hYmNkLWVmMTItMzQ1Ni1iZjc4YWJjZGVmMTIzIn0=",
15 "hasMore": true,
16 "hasPrev": true,
17 "limit": 10,
18 "currentOffset": 10,
19 "totalPages": 5,
20 "currentPage": 2,
21 "totalCount": 45
22 }
23}
Get all flows for the authenticated user with filtering and cursor pagination.
Was this page helpful?

Create flow

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Query parameters

limitstringOptional
cursorstringOptional
directionstringOptional
includeCountstringOptional
searchstringOptional

Response

Paginated list of flows
datalist of objects
paginationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error