ProcessInstances

List Process Instances

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

Agent Group where Process Instances should be fetched from

Query parameters

processGuidsstring · uuid[]Optional

Filter by Processes

startTimestring · date-timeOptional

Filter by Execution start time

endTimestring · date-timeOptional

Filter by Execution end time

stateFilterstring · enumOptional

Filter by Execution state

Possible values:

isChildProcessbooleanOptional

Filter by whether process is a child process (i.e. a subprocess, if not started manually)

continuationTokenstringOptional

If there are more results to be shown a continuationToken will be needed to show the next set of results. This token is passed as nextContinuationToken in the result of the previous query. Warning! If any filters except continuationToken are changed between requests the results will be invalid

pageSizeinteger · int32Optional

Maximum page size is 200. Default page size is 50

Default: 50

Responses

200

OK

application/json

404

Agent group not found

text/plain

get

/api/v1/instances/{agentGroupId}

HTTPcURLJavaScriptPython

GET /api/v1/instances/{agentGroupId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "parentId": 1,
      "processId": 1,
      "rootProcessId": 1,
      "processVersion": 1,
      "state": "Ok",
      "startTimeUtc": "2025-12-18T15:26:49.391Z",
      "endTimeUtc": "2025-12-18T15:26:49.391Z",
      "utcDate": "2025-12-18T15:26:49.391Z",
      "utcHour": 1,
      "executionId": "123e4567-e89b-12d3-a456-426614174000",
      "triggerId": 1,
      "agentId": 1,
      "environmentId": 1,
      "agentGroupId": 1,
      "exception": "text",
      "userName": "text",
      "stepsLoggedToBlobs": true,
      "hasLoggedSteps": true,
      "acknowledgedUtc": "2025-12-18T15:26:49.391Z",
      "commentJson": "text",
      "comment": "text",
      "promotedData": [
        {
          "id": 1,
          "processExecutionId": "123e4567-e89b-12d3-a456-426614174000",
          "timeStamp": "2025-12-18T15:26:49.391Z",
          "environmentName": "text",
          "promotedVariableName": "text",
          "promotedValueJson": "text"
        }
      ],
      "triggerName": "text",
      "environmentName": "text",
      "agentName": "text",
      "processGuid": "123e4567-e89b-12d3-a456-426614174000",
      "parentName": "text",
      "triggerRequest": [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ],
      "triggerResponses": [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ],
      "promotedColumns": [
        {
          "name": "text",
          "value": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ],
  "nextContinuationToken": "text",
  "nextLink": {
    "uri": "https://example.com",
    "method": "text"
  }
}

Get Process Instance Details

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

Agent Group where Process Instance should be fetched from

executionIdentifierstring · uuidRequired

Execution identifier of the Process Instance

Responses

200

OK

application/json

404

Process Instance not found

text/plain

get

/api/v1/instances/{agentGroupId}/{executionIdentifier}/details

HTTPcURLJavaScriptPython

GET /api/v1/instances/{agentGroupId}/{executionIdentifier}/details HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "parentId": 1,
    "parentName": "text",
    "executionId": "123e4567-e89b-12d3-a456-426614174000",
    "processGuid": "123e4567-e89b-12d3-a456-426614174000",
    "rootProcessGuid": "123e4567-e89b-12d3-a456-426614174000",
    "processVersion": 1,
    "state": "Ok",
    "steps": [
      {
        "id": 1,
        "state": "Ok",
        "stepId": "text",
        "loopParameters": [
          [
            "[Circular Reference]"
          ]
        ]
      }
    ],
    "stepDataUri": "text",
    "startTimeUtc": "2025-12-18T15:26:49.391Z",
    "endTimeUtc": "2025-12-18T15:26:49.391Z",
    "duration": "text",
    "environment": "text",
    "agentGroup": "text",
    "agent": "text",
    "exception": "text",
    "userName": "text",
    "triggerName": "text",
    "processParameters": [
      [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    ],
    "processReturnValues": [
      [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    ],
    "hasLoggedSteps": true
  }
}

Returns Process instance counts

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

Query parameters

ProcessUniqueIdentifiersstring · uuid[]Optional

The unique identifiers of the Processes to get the counts for.

StartTimestring · date-timeOptional

The start time of the execution of the Processes to get the counts for.

EndTimestring · date-timeOptional

The end time of the execution of the Processes to get the counts for.

GroupedHourlybooleanOptional

Groups counts by hour instead of by date.

CountsTimeLimitDaysinteger · int32Optional

Limit counts by days

Responses

200

The filtered Process instance counts

application/json

404

Agent group not found

application/problem+json

get

/api/v1/instances/counts/{agentGroupId}

HTTPcURLJavaScriptPython

GET /api/v1/instances/counts/{agentGroupId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "executionCounts": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": {
            "running": 1,
            "latestRunning": "2025-12-18T15:26:49.391Z",
            "successful": 1,
            "latestSuccessful": "2025-12-18T15:26:49.391Z",
            "failed": 1,
            "latestFailed": "2025-12-18T15:26:49.391Z",
            "erroredNotAcknowledged": 1,
            "latestExecutionState": "Ok"
          }
        }
      }
    }
  }
}

Acknowledges errors of specified instances of the specified Process in the specified Agent Group.

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

processGuidstring · uuidRequired

Body

application/json

reasonstringRequired

instanceIdsinteger · int64[]Required

Responses

204

Operation was successful.

400

No Agent Group ID provided.

application/problem+json

404

Could not find Agent Group with the specified ID.

application/problem+json

post

/api/v1/instances/{agentGroupId}/{processGuid}/acknowledge

HTTPcURLJavaScriptPython

POST /api/v1/instances/{agentGroupId}/{processGuid}/acknowledge HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "reason": "text",
  "instanceIds": [
    1
  ]
}

No content

Comments specified Process instances in the Agent Group.

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

processGuidstring · uuidRequired

GUID of the Process.

Body

application/json

commentstringRequired

processGuidsstring · uuid[] | nullableOptional

instanceIdsinteger · int64[]Required

Responses

200

Operation was successful.

No content

400

No Agent Group name provided.

application/problem+json

404

Could not find Agent Group with the specified ID.

application/problem+json

post

/api/v1/instances/{agentGroupId}/{processGuid}/comment

HTTPcURLJavaScriptPython

POST /api/v1/instances/{agentGroupId}/{processGuid}/comment HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "comment": "text",
  "processGuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "instanceIds": [
    1
  ]
}

No content

Downloads CSV-exported data of Process instances of a specified Process in a specified Agent Group, from a specified timespan.

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

processGuidstring · uuidRequired

Query parameters

startTimestring · date-timeOptional

endTimestring · date-timeOptional

instanceIdsinteger · int64[]Optional

IDs of the Process instances. If unspecified, the operation will return 10000 instances.

Responses

200

CSV file download.

text/csv

Responsestring · binary

400

No Agent Group name provided.

application/problem+json

404

Could not find Agent Group with the specified ID.

application/problem+json

get

/api/v1/instances/{agentGroupId}/{processGuid}/export

HTTPcURLJavaScriptPython

GET /api/v1/instances/{agentGroupId}/{processGuid}/export HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

binary

Deletes Process instances of a specified Process in a specified Agent Group.

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

processGuidstring · uuidRequired

Bodyinteger · int64[]

application/json

integer · int64[]Optional

Responses

200

Operation was successful.

No content

400

No Agent Group name provided.

application/problem+json

404

Could not find Agent Group with the specified ID.

application/problem+json

post

/api/v1/instances/{agentGroupId}/{processGuid}/delete

HTTPcURLJavaScriptPython

POST /api/v1/instances/{agentGroupId}/{processGuid}/delete HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

No content