Workflows

List of available workflow templates

This method returns a list of available workflow templates that can be used to create and run workflows. Workflow templates are predefined blueprints for workflows that include a set of tasks and their dependencies. They serve as a starting point for creating workflows, allowing users to quickly set up and execute common processes without having to define each task from scratch.

Pagination is optional: omitting page and size returns the first page with size = 50.

get/v1/workflow-templates

Request

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

Query parameters

pageinteger

Page number

sizeinteger
Example:100

Query size

name.likestring
Example:Deploy

Filter workflow templates by name using partial match

__filter.tagstring
Example:env:prod

Filter workflow templates by tag key and value. For example, __filter.tag=env:prod will return workflow templates with tag key "env" and value "prod", __filter.tag=env:* will return workflow templates with tag key "env" and any value

__filter.tag.nestring
Example:env:prod

Exclude workflow templates by tag key and value. For example, __filter.tag.ne=env:prod will exclude workflow templates with tag key "env" and value "prod", __filter.tag.ne=env:* will exclude workflow templates with tag key "env" and any value

status'PUBLISHED' | 'UNPUBLISHED'
Example:PUBLISHED

Filter workflow templates by status

status.ne'PUBLISHED' | 'UNPUBLISHED'
Example:UNPUBLISHED

Exclude workflow templates by status

sortstring[]

Sorting criteria in the format field,direction (e.g. createdAt,desc). Repeat the parameter for multiple sort fields. Default: createdAt,desc. Allowed fields: name, createdAt, status, resourceTypes, isDefault. Note: sorting by resourceTypes orders by the canonical set of resource types (each value lower-cased, then sorted), so templates with the same set of types group together.

[
  "createdAt,desc"
]

Response

Successful operation

totalPagesinteger

Total number of pages available

totalElementsinteger

Total number of elements across all pages

sizeinteger

Number of elements per page

numberinteger

Current page number (0-based index)

lastboolean

Indicates if this is the last page

firstboolean

Indicates if this is the first page

numberOfElementsinteger

Number of elements on the current page

emptyboolean

Indicates if the page is empty

Example response

{
  "content": [
    {
      "id": 123,
      "name": "Sample Workflow Template",
      "description": "This is a sample workflow template for demonstration purposes.",
      "createdAt": "2026-06-26T21:44:05.345Z",
      "createdByName": "Automation User",
      "createdById": 123,
      "modifiedAt": "2026-07-07T07:38:16.285Z",
      "modifiedByName": "Automation User",
      "modifiedById": 123,
      "status": "PUBLISHED",
      "resourceTypes": [
        "COMPUTE"
      ],
      "resourceType": "COMPUTE",
      "activeVersionId": 123,
      "activeVersionName": "v1",
      "resourceParams": [
        {
          "name": "minCpuCores",
          "value": "4"
        }
      ],
      "tags": [
        {
          "key": "env",
          "value": "dev"
        }
      ],
      "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.