---
title: "List Process Instances"
method: GET
path: "/api/v1/instances/{agentGroupId}"
tags: ["ProcessInstances"]
---

# List Process Instances

`GET /api/v1/instances/{agentGroupId}`

## Path parameters

- `agentGroupId` integer, required

## Query parameters

- `processGuids` string[]
- `startTime` string, date-time
- `endTime` string, date-time
- `stateFilter` 'ShowAll' | 'ShowRunning' | 'ShowFinished' | 'ShowSuccessful' | 'ShowFailed' | 'ShowFailedNotAcknowledged'
- `isChildProcess` boolean
- `continuationToken` string
- `pageSize` integer

## Response `200`

OK

- DtoProcessInstanceGet
  - `data` ProcessInstanceViewModel[] — Response data
    - `id` integer
    - `parentId` integer, nullable
    - `processId` integer
    - `rootProcessId` integer, nullable
    - `processVersion` integer
    - `state` 'Ok' | 'Waiting' | 'Launched' | 'Starting' | 'Started' | 'Canceled' | 'CanceledByTerminate' | 'FinishedAsZombie' | 'TerminatedByUser' | 'ActionSkipped' | 'Failed' | 'Exception' | 'Finished'
    - `startTimeUtc` string, date-time, nullable
    - `endTimeUtc` string, date-time, nullable
    - `utcDate` string, date-time
    - `utcHour` integer
    - `executionId` string, uuid
    - `triggerId` integer, nullable
    - `agentId` integer
    - `environmentId` integer
    - `agentGroupId` integer
    - `exception` string, nullable
    - `userName` string, nullable
    - `stepsLoggedToBlobs` boolean, nullable
    - `hasLoggedSteps` boolean, nullable
    - `acknowledgedUtc` string, date-time, nullable
    - `commentJson` string, nullable
    - `comment` string
    - `promotedData` ProcessPromotedData[], nullable
      - `id` integer
      - `processExecutionId` string, uuid
      - `timeStamp` string, date-time
      - `environmentName` string, required
      - `promotedVariableName` string, required
      - `promotedValueJson` string, required
    - `triggerName` string, nullable
    - `environmentName` string, nullable
    - `agentName` string, nullable
    - `processGuid` string, uuid
    - `parentName` string, nullable
    - `triggerRequest` JToken[]
    - `triggerResponses` JToken[]
    - `promotedColumns` PromotedColumn[], nullable
      - `name` string, nullable
      - `value` JToken[]
  - `nextContinuationToken` string, nullable — ContinuationToken to be used in the next query <b>Warning! If any filters except continuationToken are changed between requests the results will be invalid</b> <br>If the token is null there are no more results to fetch with the selected filters</br>
  - `nextLink` LinkModel
    - `uri` string, uri
    - `method` string

## Other responses

- `404` — Agent group not found

---

[API](https://skmtc.dev/frends/apis/frends-api.md) · [All operations](https://skmtc.dev/frends/apis/frends-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/frends/frends-api/revisions/cf4c0a0d1c8a/schema)