List Workflow Deployments | Vellum

from vellum import Vellum
client = Vellum(
    api_version="YOUR_API_VERSION",
    api_key="YOUR_API_KEY",
)
client.workflow_deployments.list()

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "string",
      "name": "string",
      "label": "string",
      "created": "2024-01-15T09:30:00Z",
      "last_deployed_on": "2024-01-15T09:30:00Z",
      "input_variables": [
        {
          "id": "string",
          "key": "string",
          "type": "STRING",
          "required": true,
          "default": {
            "type": "STRING",
            "value": "string"
          },
          "extensions": {
            "color": "string",
            "description": "string",
            "title": "string"
          },
          "schema": {}
        }
      ],
      "output_variables": [
        {
          "id": "string",
          "key": "string",
          "type": "STRING",
          "required": true,
          "default": {
            "type": "STRING",
            "value": "string"
          },
          "extensions": {
            "color": "string",
            "description": "string",
            "title": "string"
          },
          "schema": {}
        }
      ],
      "status": "ACTIVE",
      "environment": "DEVELOPMENT",
      "description": "string"
    }
  ]
}

Used to list all Workflow Deployments.

Authentication

X-API-KEYstring

API Key authentication via header

Query parameters

has_story_configstringOptional

has_story_config

is_publicstringOptional

is_public

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Specifies the ordering of the returned Workflow Deployments. Valid values are:

created - Orders by creation time in ascending order.
-created - Orders by creation time in descending order. (default)
name - Orders by name in ascending order.
-name - Orders by name in descending order.

Compound orderings are supported by separating fields with commas, e.g., -created,name.

Specifies the ordering of the returned Workflow Deployments. Valid values are: - `created` - Orders by creation time in ascending order. - `-created` - Orders by creation time in descending order. (default) - `name` - Orders by name in ascending order. - `-name` - Orders by name in descending order. Compound orderings are supported by separating fields with commas, e.g., `-created,name`.

owned_bystringOptional

owned_by

statusenumOptional

status

Allowed values:

Response

countinteger or null

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

resultslist of objects or null

Authentication

Headers

Query parameters

Response