Skip to main content
POST
/
v2
/
workflow
/
definitions
/
list
List Definitions
curl --request POST \
  --url https://api.velt.dev/v2/workflow/definitions/list \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "pageSize": 123,
    "cursor": 123,
    "organizationId": "<string>",
    "documentId": "<string>"
  }
}
'
{
  "result": {
    "items": [],
    "nextCursor": 1714300000000
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.velt.dev/llms.txt

Use this file to discover all available pages before exploring further.

Use this API to paginate through active (non-tombstoned) workflow definitions, ordered by updatedAt DESC.

​
Endpoint

POST https://api.velt.dev/v2/workflow/definitions/list

​
Headers

​
x-velt-api-key
string
required
Your API key.
​
x-velt-auth-token
string
required
Your Auth Token.

​
Body

​
Params

​
data
object
required
Requires a Firestore composite index (status ASC, updatedAt DESC). The first list call after deploy may surface a one-time index-create URL.

​
Example Requests

​
List the first page

{
  "data": {
    "pageSize": 50
  }
}

​
Paginate

{
  "data": {
    "pageSize": 50,
    "cursor": 1714300000000
  }
}

​
Response

​
Success Response

{
  "result": {
    "items": [ /* DefinitionView[] */ ],
    "nextCursor": 1714300000000
  }
}

​
Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
  "result": {
    "items": [],
    "nextCursor": 1714300000000
  }
}