List

GET

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/flows

GET

/v1/landscapes/:landscapeId/versions/:versionId/flows

1 import { IcePanelClient } from "@icepanel/sdk";
2 
3 async function main() {
4     const client = new IcePanelClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.flows.list("landscapeId", "versionId", {});
8 }
9 main();

1 {
2   "flows": [
3     {
4       "commit": 1.1,
5       "index": 1.1,
6       "labels": {},
7       "name": "string",
8       "pinned": true,
9       "showAllSteps": true,
10       "showConnectionNames": true,
11       "steps": {},
12       "diagramId": "string",
13       "handleId": "string",
14       "createdAt": "2024-01-15T09:30:00Z",
15       "createdBy": "user",
16       "createdById": "string",
17       "id": "string",
18       "landscapeId": "string",
19       "updatedAt": "2024-01-15T09:30:00Z",
20       "updatedBy": "user",
21       "updatedById": "string",
22       "version": 1.1,
23       "versionId": "string",
24       "pinnedAt": "2024-01-15T09:30:00Z",
25       "pinnedIndex": 1.1,
26       "deletedAt": "2024-01-15T09:30:00Z",
27       "deletedBy": "user",
28       "deletedById": "string",
29       "latestEntityId": "string",
30       "viewedAt": "2024-01-15T09:30:00Z",
31       "viewedBy": "user",
32       "viewedById": "string"
33     }
34   ]
35 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

filterobjectOptional

Response

flowslist of objects

Authentication

Path parameters

Query parameters

Response

Errors