API Reference Workflows Workflow Deployments

List Workflow Deployments

Beta

GET

Used to list all Workflow Deployments.

Query parameters

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

status"ACTIVE" or "ARCHIVED"Optional

status

Allowed values: ACTIVEARCHIVED

Response

This endpoint returns an object

countintegerOptional

nextstringOptional

previousstringOptional

resultslist of objectsOptional

GET

1 curl https://api.vellum.ai/v1/workflow-deployments \
2      -H "X_API_KEY: <apiKey>"

200Retrieved

1 {
2   "count": 123,
3   "next": "http://api.example.org/accounts/?offset=400&limit=100",
4   "previous": "http://api.example.org/accounts/?offset=200&limit=100",
5   "results": [
6     {
7       "id": "id",
8       "name": "name",
9       "label": "label",
10       "status": "ACTIVE",
11       "environment": "DEVELOPMENT",
12       "created": "2024-01-15T09:30:00Z",
13       "last_deployed_on": "2024-01-15T09:30:00Z",
14       "input_variables": [
15         {
16           "id": "id",
17           "key": "key",
18           "type": "STRING"
19         }
20       ],
21       "output_variables": [
22         {
23           "id": "id",
24           "key": "key",
25           "type": "STRING"
26         }
27       ],
28       "description": "description"
29     }
30   ]
31 }

Built with

1	curl https://api.vellum.ai/v1/workflow-deployments \
2	-H "X_API_KEY: <apiKey>"

1	{
2	"count": 123,
3	"next": "http://api.example.org/accounts/?offset=400&limit=100",
4	"previous": "http://api.example.org/accounts/?offset=200&limit=100",
5	"results": [
6	{
7	"id": "id",
8	"name": "name",
9	"label": "label",
10	"status": "ACTIVE",
11	"environment": "DEVELOPMENT",
12	"created": "2024-01-15T09:30:00Z",
13	"last_deployed_on": "2024-01-15T09:30:00Z",
14	"input_variables": [
15	{
16	"id": "id",
17	"key": "key",
18	"type": "STRING"
19	}
20	],
21	"output_variables": [
22	{
23	"id": "id",
24	"key": "key",
25	"type": "STRING"
26	}
27	],
28	"description": "description"
29	}
30	]
31	}