API Reference

Automations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

ListWorkflowExecutions

POST/gitpod.v1.WorkflowService/ListWorkflowExecutions

Lists workflow executions with optional filtering.

Use this method to:

• Monitor workflow execution history
• Track execution status
• Debug workflow issues

Examples

• List executions for workflow:

  Shows all executions for a specific workflow.

  filter:
    workflowIds: ["b0e12f6c-4c67-429d-a4a6-d9838b5da047"]
  pagination:
    pageSize: 20

Query ParametersExpand Collapse

token: optional string

pageSize: optional number

maximum100

minimum0

Body ParametersJSONExpand Collapse

filter: optional object { hasFailedActions, search, statusPhases, 2 more }

hasFailedActions: optional boolean

search: optional string

search performs case-insensitive search across workflow execution ID and trigger type

maxLength256

statusPhases: optional array of "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED" or "WORKFLOW_EXECUTION_PHASE_PENDING" or "WORKFLOW_EXECUTION_PHASE_RUNNING" or 5 more

One of the following:

"WORKFLOW_EXECUTION_PHASE_UNSPECIFIED"

"WORKFLOW_EXECUTION_PHASE_PENDING"

"WORKFLOW_EXECUTION_PHASE_RUNNING"

"WORKFLOW_EXECUTION_PHASE_STOPPING"

"WORKFLOW_EXECUTION_PHASE_STOPPED"

"WORKFLOW_EXECUTION_PHASE_DELETING"

"WORKFLOW_EXECUTION_PHASE_DELETED"

"WORKFLOW_EXECUTION_PHASE_COMPLETED"

workflowExecutionIds: optional array of string

workflowIds: optional array of string

pagination: optional object { token, pageSize }

token: optional string

Token for the next set of results that was returned as next_token of a PaginationResponse

pageSize: optional number

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

sort: optional Sort { field, order }

sort specifies the order of results. When unspecified, results are sorted by operational priority (running first, then failed, then completed, then others). Supported sort fields: startedAt, finishedAt, createdAt.

field: optional string

Field name to sort by, in camelCase.

order: optional SortOrder

One of the following:

"SORT_ORDER_UNSPECIFIED"

"SORT_ORDER_ASC"

"SORT_ORDER_DESC"

ReturnsExpand Collapse

pagination: optional object { nextToken }

nextToken: optional string

Token passed for retrieving the next set of results. Empty if there are no more results

workflowExecutions: optional array of WorkflowExecution { id, metadata, spec, status }

id: optional string

formatuuid

metadata: optional object { creator, executor, finishedAt, 2 more }

WorkflowExecutionMetadata contains workflow execution metadata.

creator: optional Subject { id, principal }

id: optional string

id is the UUID of the subject

formatuuid

principal: optional Principal

Principal is the principal of the subject

One of the following:

"PRINCIPAL_UNSPECIFIED"

"PRINCIPAL_ACCOUNT"

"PRINCIPAL_USER"

"PRINCIPAL_RUNNER"

"PRINCIPAL_ENVIRONMENT"

"PRINCIPAL_SERVICE_ACCOUNT"

"PRINCIPAL_RUNNER_MANAGER"

executor: optional Subject { id, principal }

id: optional string

id is the UUID of the subject

formatuuid

principal: optional Principal

Principal is the principal of the subject

One of the following:

"PRINCIPAL_UNSPECIFIED"

"PRINCIPAL_ACCOUNT"

"PRINCIPAL_USER"

"PRINCIPAL_RUNNER"

"PRINCIPAL_ENVIRONMENT"

"PRINCIPAL_SERVICE_ACCOUNT"

"PRINCIPAL_RUNNER_MANAGER"

finishedAt: optional string

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time

startedAt: optional string

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time

workflowId: optional string

formatuuid

spec: optional object { action, report, trigger }

WorkflowExecutionSpec contains the specification used for this execution.

action: optional WorkflowAction { limits, steps }

WorkflowAction defines the actions to be executed in a workflow.

limits: object { maxParallel, maxTotal, perExecution }

Limits defines execution limits for workflow actions. Concurrent actions limit cannot exceed total actions limit:

this.max_parallel <= this.max_total

maxParallel: optional number

Maximum parallel actions must be between 1 and 25:

this >= 1 && this <= 25

formatint32

maxTotal: optional number

Maximum total actions must be between 1 and 100:

this >= 1 && this <= 100

formatint32

perExecution: optional object { maxTime }

PerExecution defines limits per execution action.

maxTime: optional string

Maximum time allowed for a single execution action. Use standard duration format (e.g., “30m” for 30 minutes, “2h” for 2 hours).

formatregex

steps: optional array of WorkflowStep { agent, pullRequest, task }

Automation must have between 1 and 50 steps:

size(this) >= 1 && size(this) <= 50

agent: optional object { prompt }

WorkflowAgentStep represents an agent step that executes with a prompt.

prompt: optional string

Prompt must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

pullRequest: optional object { branch, description, draft, title }

WorkflowPullRequestStep represents a pull request creation step.

branch: optional string

Branch name must be between 1 and 255 characters:

size(this) >= 1 && size(this) <= 255

description: optional string

Description must be at most 20,000 characters:

size(this) <= 20000

draft: optional boolean

title: optional string

Title must be between 1 and 500 characters:

size(this) >= 1 && size(this) <= 500

task: optional object { command }

WorkflowTaskStep represents a task step that executes a command.

command: optional string

Command must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

report: optional WorkflowAction { limits, steps }

WorkflowAction defines the actions to be executed in a workflow.

limits: object { maxParallel, maxTotal, perExecution }

Limits defines execution limits for workflow actions. Concurrent actions limit cannot exceed total actions limit:

this.max_parallel <= this.max_total

maxParallel: optional number

Maximum parallel actions must be between 1 and 25:

this >= 1 && this <= 25

formatint32

maxTotal: optional number

Maximum total actions must be between 1 and 100:

this >= 1 && this <= 100

formatint32

perExecution: optional object { maxTime }

PerExecution defines limits per execution action.

maxTime: optional string

Maximum time allowed for a single execution action. Use standard duration format (e.g., “30m” for 30 minutes, “2h” for 2 hours).

formatregex

steps: optional array of WorkflowStep { agent, pullRequest, task }

Automation must have between 1 and 50 steps:

size(this) >= 1 && size(this) <= 50

agent: optional object { prompt }

WorkflowAgentStep represents an agent step that executes with a prompt.

prompt: optional string

Prompt must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

pullRequest: optional object { branch, description, draft, title }

WorkflowPullRequestStep represents a pull request creation step.

branch: optional string

Branch name must be between 1 and 255 characters:

size(this) >= 1 && size(this) <= 255

description: optional string

Description must be at most 20,000 characters:

size(this) <= 20000

draft: optional boolean

title: optional string

Title must be between 1 and 500 characters:

size(this) >= 1 && size(this) <= 500

task: optional object { command }

WorkflowTaskStep represents a task step that executes a command.

command: optional string

Command must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

trigger: optional object { context, manual, pullRequest, time }

WorkflowExecutionTrigger represents a workflow execution trigger instance.

context: WorkflowTriggerContext { agent, fromTrigger, projects, repositories }

Context from the workflow trigger - copied at execution time for immutability. This allows the reconciler to create actions without fetching the workflow definition.

agent: optional object { prompt }

Execute workflow in agent-managed environments. Agent receives the specified prompt and manages execution context.

prompt: optional string

Agent prompt must be between 1 and 20,000 characters:

size(this) >= 1 && size(this) <= 20000

fromTrigger: optional unknown

Use context derived from the trigger event. Currently only supported for PullRequest triggers - uses PR repository context.

projects: optional object { projectIds }

Execute workflow in specific project environments. Creates environments for each specified project.

projectIds: optional array of string

repositories: optional object { environmentClassId, repoSelector, repositoryUrls }

Execute workflow in environments created from repository URLs. Supports both explicit repository URLs and search patterns.

environmentClassId: optional string

formatuuid

repoSelector: optional object { repoSearchString, scmHost }

RepositorySelector defines how to select repositories for workflow execution. Combines a search string with an SCM host to identify repositories.

repoSearchString: optional string

Search string to match repositories using SCM-specific search patterns. For GitHub: supports GitHub search syntax (e.g., “org:gitpod-io language:go”, “user:octocat stars:>100”) For GitLab: supports GitLab search syntax See SCM provider documentation for supported search patterns.

minLength1

scmHost: optional string

SCM host where the search should be performed (e.g., “github.com”, “gitlab.com”)

minLength1

repositoryUrls: optional object { repoUrls }

RepositoryURLs contains a list of explicit repository URLs. Creates one action per repository URL.

repoUrls: optional array of string

manual: optional unknown

Manual trigger - empty message since no additional data needed

pullRequest: optional object { id, author, draft, 6 more }

PullRequest represents pull request metadata from source control systems. This message is used across workflow triggers, executions, and agent contexts to maintain consistent PR information throughout the system.

id: optional string

Unique identifier from the source system (e.g., “123” for GitHub PR #123)

author: optional string

Author name as provided by the SCM system

draft: optional boolean

Whether this is a draft pull request

fromBranch: optional string

Source branch name (the branch being merged from)

repository: optional object { cloneUrl, host, name, owner }

Repository information

cloneUrl: optional string

host: optional string

name: optional string

owner: optional string

state: optional State

Current state of the pull request

One of the following:

"STATE_UNSPECIFIED"

"STATE_OPEN"

"STATE_CLOSED"

"STATE_MERGED"

title: optional string

Pull request title

toBranch: optional string

Target branch name (the branch being merged into)

url: optional string

Pull request URL (e.g., “https://github.com/owner/repo/pull/123”)

time: optional object { triggeredAt }

Time trigger - just the timestamp when it was triggered

triggeredAt: optional string

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are “smeared” so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

 Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

 struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

 FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

 long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

 Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

 timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is “{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z” where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The “Z” suffix indicates the timezone (“UTC”); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by “Z”) when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, “2017-01-15T01:30:15.01Z” encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec ‘%Y-%m-%dT%H:%M:%S.%fZ’. Likewise, in Java, one can use the Joda Time’s ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

formatdate-time

status: optional object { doneActionCount, failedActionCount, failures, 5 more }

WorkflowExecutionStatus contains the current status of a workflow execution.

doneActionCount: optional number

formatint32

failedActionCount: optional number

formatint32

failures: optional array of object { code, message, meta, 2 more }

Structured failures that caused the workflow execution to fail. Provides detailed error codes, messages, and retry information.

code: optional "WORKFLOW_ERROR_CODE_UNSPECIFIED" or "WORKFLOW_ERROR_CODE_ENVIRONMENT_ERROR" or "WORKFLOW_ERROR_CODE_AGENT_ERROR"

Error code identifying the type of error.

One of the following:

"WORKFLOW_ERROR_CODE_UNSPECIFIED"

"WORKFLOW_ERROR_CODE_ENVIRONMENT_ERROR"

"WORKFLOW_ERROR_CODE_AGENT_ERROR"

message: optional string

Human-readable error message.

meta: optional map[string]

Additional metadata about the error. Common keys include:

• environment_id: ID of the environment
• task_id: ID of the task
• service_id: ID of the service
• workflow_id: ID of the workflow
• workflow_execution_id: ID of the workflow execution

reason: optional string

Reason explaining why the error occurred. Examples: “not_found”, “stopped”, “deleted”, “creation_failed”, “start_failed”

retry: optional object { retriable, retryAfter }

Retry configuration. If not set, the error is considered non-retriable.

retriable: optional boolean

Whether the error is retriable.

retryAfter: optional string

Suggested duration to wait before retrying. Only meaningful when retriable is true.

formatregex

pendingActionCount: optional number

formatint32

phase: optional "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED" or "WORKFLOW_EXECUTION_PHASE_PENDING" or "WORKFLOW_EXECUTION_PHASE_RUNNING" or 5 more

One of the following:

"WORKFLOW_EXECUTION_PHASE_UNSPECIFIED"

"WORKFLOW_EXECUTION_PHASE_PENDING"

"WORKFLOW_EXECUTION_PHASE_RUNNING"

"WORKFLOW_EXECUTION_PHASE_STOPPING"

"WORKFLOW_EXECUTION_PHASE_STOPPED"

"WORKFLOW_EXECUTION_PHASE_DELETING"

"WORKFLOW_EXECUTION_PHASE_DELETED"

"WORKFLOW_EXECUTION_PHASE_COMPLETED"

runningActionCount: optional number

formatint32

stoppedActionCount: optional number

formatint32

warnings: optional array of object { code, message, meta, 2 more }

Structured warnings about the workflow execution. Provides detailed warning codes and messages.

code: optional "WORKFLOW_ERROR_CODE_UNSPECIFIED" or "WORKFLOW_ERROR_CODE_ENVIRONMENT_ERROR" or "WORKFLOW_ERROR_CODE_AGENT_ERROR"

Error code identifying the type of error.

One of the following:

"WORKFLOW_ERROR_CODE_UNSPECIFIED"

"WORKFLOW_ERROR_CODE_ENVIRONMENT_ERROR"

"WORKFLOW_ERROR_CODE_AGENT_ERROR"

message: optional string

Human-readable error message.

meta: optional map[string]

Additional metadata about the error. Common keys include:

• environment_id: ID of the environment
• task_id: ID of the task
• service_id: ID of the service
• workflow_id: ID of the workflow
• workflow_execution_id: ID of the workflow execution

reason: optional string

Reason explaining why the error occurred. Examples: “not_found”, “stopped”, “deleted”, “creation_failed”, “start_failed”

retry: optional object { retriable, retryAfter }

Retry configuration. If not set, the error is considered non-retriable.

retriable: optional boolean

Whether the error is retriable.

retryAfter: optional string

Suggested duration to wait before retrying. Only meaningful when retriable is true.

formatregex

ListWorkflowExecutions

HTTP

HTTP

TypeScript

Python

Go

curl https://app.gitpod.io/api/gitpod.v1.WorkflowService/ListWorkflowExecutions \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

200 example

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "workflowExecutions": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "metadata": {
        "creator": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "principal": "PRINCIPAL_UNSPECIFIED"
        },
        "executor": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "principal": "PRINCIPAL_UNSPECIFIED"
        },
        "finishedAt": "2019-12-27T18:11:19.117Z",
        "startedAt": "2019-12-27T18:11:19.117Z",
        "workflowId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
      },
      "spec": {
        "action": {
          "limits": {
            "maxParallel": 0,
            "maxTotal": 0,
            "perExecution": {
              "maxTime": "+9125115.360s"
            }
          },
          "steps": [
            {
              "agent": {
                "prompt": "prompt"
              },
              "pullRequest": {
                "branch": "branch",
                "description": "description",
                "draft": true,
                "title": "title"
              },
              "report": {
                "outputs": [
                  {
                    "acceptanceCriteria": "acceptanceCriteria",
                    "boolean": {},
                    "command": "command",
                    "float": {
                      "max": 0,
                      "min": 0
                    },
                    "integer": {
                      "max": 0,
                      "min": 0
                    },
                    "key": "key",
                    "prompt": "prompt",
                    "string": {
                      "pattern": "pattern"
                    },
                    "title": "title"
                  }
                ]
              },
              "task": {
                "command": "command"
              }
            }
          ]
        },
        "desiredPhase": "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED",
        "report": {
          "limits": {
            "maxParallel": 0,
            "maxTotal": 0,
            "perExecution": {
              "maxTime": "+9125115.360s"
            }
          },
          "steps": [
            {
              "agent": {
                "prompt": "prompt"
              },
              "pullRequest": {
                "branch": "branch",
                "description": "description",
                "draft": true,
                "title": "title"
              },
              "report": {
                "outputs": [
                  {
                    "acceptanceCriteria": "acceptanceCriteria",
                    "boolean": {},
                    "command": "command",
                    "float": {
                      "max": 0,
                      "min": 0
                    },
                    "integer": {
                      "max": 0,
                      "min": 0
                    },
                    "key": "key",
                    "prompt": "prompt",
                    "string": {
                      "pattern": "pattern"
                    },
                    "title": "title"
                  }
                ]
              },
              "task": {
                "command": "command"
              }
            }
          ]
        },
        "session": "session",
        "trigger": {
          "context": {
            "agent": {
              "prompt": "prompt"
            },
            "fromTrigger": {},
            "projects": {
              "projectIds": [
                "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              ]
            },
            "repositories": {
              "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "repoSelector": {
                "repoSearchString": "x",
                "scmHost": "x"
              },
              "repositoryUrls": {
                "repoUrls": [
                  "x"
                ]
              }
            }
          },
          "manual": {},
          "pullRequest": {
            "id": "id",
            "author": "author",
            "draft": true,
            "fromBranch": "fromBranch",
            "repository": {
              "cloneUrl": "cloneUrl",
              "host": "host",
              "name": "name",
              "owner": "owner"
            },
            "state": "STATE_UNSPECIFIED",
            "title": "title",
            "toBranch": "toBranch",
            "url": "url"
          },
          "time": {
            "triggeredAt": "2019-12-27T18:11:19.117Z"
          }
        }
      },
      "status": {
        "doneActionCount": 0,
        "failedActionCount": 0,
        "failureMessage": "failureMessage",
        "failures": [
          {
            "code": "WORKFLOW_ERROR_CODE_UNSPECIFIED",
            "message": "message",
            "meta": {
              "foo": "string"
            },
            "reason": "reason",
            "retry": {
              "retriable": true,
              "retryAfter": "+9125115.360s"
            }
          }
        ],
        "pendingActionCount": 0,
        "phase": "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED",
        "runningActionCount": 0,
        "session": "session",
        "stoppedActionCount": 0,
        "warningMessage": "warningMessage",
        "warnings": [
          {
            "code": "WORKFLOW_ERROR_CODE_UNSPECIFIED",
            "message": "message",
            "meta": {
              "foo": "string"
            },
            "reason": "reason",
            "retry": {
              "retriable": true,
              "retryAfter": "+9125115.360s"
            }
          }
        ]
      }
    }
  ]
}

Returns Examples

200 example

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "workflowExecutions": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "metadata": {
        "creator": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "principal": "PRINCIPAL_UNSPECIFIED"
        },
        "executor": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "principal": "PRINCIPAL_UNSPECIFIED"
        },
        "finishedAt": "2019-12-27T18:11:19.117Z",
        "startedAt": "2019-12-27T18:11:19.117Z",
        "workflowId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
      },
      "spec": {
        "action": {
          "limits": {
            "maxParallel": 0,
            "maxTotal": 0,
            "perExecution": {
              "maxTime": "+9125115.360s"
            }
          },
          "steps": [
            {
              "agent": {
                "prompt": "prompt"
              },
              "pullRequest": {
                "branch": "branch",
                "description": "description",
                "draft": true,
                "title": "title"
              },
              "report": {
                "outputs": [
                  {
                    "acceptanceCriteria": "acceptanceCriteria",
                    "boolean": {},
                    "command": "command",
                    "float": {
                      "max": 0,
                      "min": 0
                    },
                    "integer": {
                      "max": 0,
                      "min": 0
                    },
                    "key": "key",
                    "prompt": "prompt",
                    "string": {
                      "pattern": "pattern"
                    },
                    "title": "title"
                  }
                ]
              },
              "task": {
                "command": "command"
              }
            }
          ]
        },
        "desiredPhase": "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED",
        "report": {
          "limits": {
            "maxParallel": 0,
            "maxTotal": 0,
            "perExecution": {
              "maxTime": "+9125115.360s"
            }
          },
          "steps": [
            {
              "agent": {
                "prompt": "prompt"
              },
              "pullRequest": {
                "branch": "branch",
                "description": "description",
                "draft": true,
                "title": "title"
              },
              "report": {
                "outputs": [
                  {
                    "acceptanceCriteria": "acceptanceCriteria",
                    "boolean": {},
                    "command": "command",
                    "float": {
                      "max": 0,
                      "min": 0
                    },
                    "integer": {
                      "max": 0,
                      "min": 0
                    },
                    "key": "key",
                    "prompt": "prompt",
                    "string": {
                      "pattern": "pattern"
                    },
                    "title": "title"
                  }
                ]
              },
              "task": {
                "command": "command"
              }
            }
          ]
        },
        "session": "session",
        "trigger": {
          "context": {
            "agent": {
              "prompt": "prompt"
            },
            "fromTrigger": {},
            "projects": {
              "projectIds": [
                "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              ]
            },
            "repositories": {
              "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "repoSelector": {
                "repoSearchString": "x",
                "scmHost": "x"
              },
              "repositoryUrls": {
                "repoUrls": [
                  "x"
                ]
              }
            }
          },
          "manual": {},
          "pullRequest": {
            "id": "id",
            "author": "author",
            "draft": true,
            "fromBranch": "fromBranch",
            "repository": {
              "cloneUrl": "cloneUrl",
              "host": "host",
              "name": "name",
              "owner": "owner"
            },
            "state": "STATE_UNSPECIFIED",
            "title": "title",
            "toBranch": "toBranch",
            "url": "url"
          },
          "time": {
            "triggeredAt": "2019-12-27T18:11:19.117Z"
          }
        }
      },
      "status": {
        "doneActionCount": 0,
        "failedActionCount": 0,
        "failureMessage": "failureMessage",
        "failures": [
          {
            "code": "WORKFLOW_ERROR_CODE_UNSPECIFIED",
            "message": "message",
            "meta": {
              "foo": "string"
            },
            "reason": "reason",
            "retry": {
              "retriable": true,
              "retryAfter": "+9125115.360s"
            }
          }
        ],
        "pendingActionCount": 0,
        "phase": "WORKFLOW_EXECUTION_PHASE_UNSPECIFIED",
        "runningActionCount": 0,
        "session": "session",
        "stoppedActionCount": 0,
        "warningMessage": "warningMessage",
        "warnings": [
          {
            "code": "WORKFLOW_ERROR_CODE_UNSPECIFIED",
            "message": "message",
            "meta": {
              "foo": "string"
            },
            "reason": "reason",
            "retry": {
              "retriable": true,
              "retryAfter": "+9125115.360s"
            }
          }
        ]
      }
    }
  ]
}