Get Definition

POST /v2/workflow/definitions/get

Get Definition

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workflow/definitions/get \
  --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": {
    "definitionId": "<string>",
    "organizationId": "<string>",
    "documentId": "<string>"
  }
}
'

{
  "result": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "description": null,
    "version": 1,
    "scope": { "level": "apiKey", "organizationId": null, "documentId": null },
    "nodes": [],
    "edges": [],
    "groups": [],
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}

Use this API to fetch a workflow definition. Returns the full DefinitionView. Filters out tombstoned definitions.

Endpoint

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

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

definitionId · string · required

The definition to fetch.

organizationId · string

Required when scoped to an organization or document.

documentId · string

Required when scoped to a document.

Example Requests

Get a definition

{
  "data": {
    "definitionId": "marketing-copy-approval"
  }
}

Response

Success Response

{
  "result": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "description": null,
    "version": 1,
    "scope": { "level": "apiKey", "organizationId": null, "documentId": null },
    "nodes": [ /* full node array */ ],
    "edges": [ /* full edge array */ ],
    "groups": [ /* full group array */ ],
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}

Failure Response

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

Errors: NOT_FOUND (definition does not exist or is tombstoned) / INVALID_ARGUMENT.

{
  "result": {
    "definitionId": "marketing-copy-approval",
    "name": "Marketing copy approval",
    "description": null,
    "version": 1,
    "scope": { "level": "apiKey", "organizationId": null, "documentId": null },
    "nodes": [],
    "edges": [],
    "groups": [],
    "triggers": null,
    "tags": null,
    "custom": null,
    "createdAt": 1731432000000,
    "updatedAt": 1731432000000,
    "status": "active"
  }
}