Workflows

Get a workflow template version by ID

Returns the full immutable snapshot of a specific version, including all fields captured at the time of the save (name, description, status, resourceTypes, resourceParams, tags, contentType, content, isContentValid, contentParams) plus the version-level metadata (isActive, secretsChanged, createdAt, createdBy*). Secret content parameter values are never returned — defaultValue is always null for parameters with isSecret = true; use hasDefaultValue = true to detect that a stored secret exists.

get/v1/workflow-templates/{id}/versions/{versionId}

Request

  • Base URL
    https://api.emma.ms/external
  • Auth
    HTTP bearer

Path parameters

idinteger required

ID of the workflow template

versionIdinteger required

ID of the workflow template version

Response

Successful operation

idinteger required

ID of the workflow template version

namestring required

Name of the workflow version

createdAtstring required

Date and time of the version creation.

createdByIdinteger required

ID of the user or service application that initiated creation of the version.

createdByNamestring required

Name of the user or service application that initiated creation of the version.

isActiveboolean required

Indicates whether the workflow version is active

secretsChangedboolean required

Indicates whether the secrets were changed in this version.

tagsRestorableboolean nullable

Indicates whether all tags in the snapshot can be restored. true if every tag still exists in the company, false if at least one has been deleted and cannot be restored.

null when restorability was not determined — the snapshot holds no tags at all, or the check could not be completed. Treat null as "unknown", not as false.

sequenceNumberinteger required

A sequential number assigned to each version in creation order.

restoredFrominteger nullable

ID of the source version. Present only if this version was created by restoring another version; null otherwise.

restoredFromNamestring nullable

Name of the source version. Present only if this version was created by restoring another version; null otherwise.

Example response

{
  "id": 123,
  "name": "v1",
  "createdAt": "2026-11-26T14:54:11",
  "createdById": 543,
  "createdByName": "Automation User",
  "tagsRestorable": true,
  "sequenceNumber": 7,
  "restoredFrom": 123,
  "restoredFromName": "v11",
  "snapshot": {
    "name": "Deploy MongoDB",
    "description": "Deploy MongoDB from a shell script.",
    "status": "PUBLISHED",
    "resourceTypes": [
      "COMPUTE"
    ],
    "resourceParams": [
      {
        "name": "minCpuCores",
        "value": "4"
      }
    ],
    "tags": [
      {
        "tagId": "123",
        "key": "environment",
        "value": "production"
      }
    ],
    "contentType": "Shell",
    "content": "echo Hello, World!",
    "isContentValid": true,
    "contentParams": [
      {
        "name": "command1",
        "defaultValue": "echo Hello, World!",
        "mandatory": true,
        "description": "Database password used by the deployment script.",
        "hasDefaultValue": true,
        "vaultVersion": 1
      }
    ],
    "contentExecutionTimeout": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.