> ## Documentation Index
> Fetch the complete documentation index at: https://velt.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Executions

Use this API to paginate through workflow executions. Filter by `definitionId` and/or `status`.

# Endpoint

`POST https://api.velt.dev/v2/workflow/executions/list`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

#### Params

**data** `object` *required*

**properties**

**definitionId** `string`

Filter by definition.

**status** `string`

Filter by status. One of: `pending` / `running` / `completed` / `failed` / `cancelled`.

**pageSize** `integer`

1–500. Default 50.

**cursor** `string`

The previous response's `nextCursor` (last item's `startedAt` epoch ms, as a string). Pass it back unchanged.

> [!NOTE]
>
> `List Executions` does not accept `organizationId` or `documentId` filters. List items return `steps: []`; call [Get Execution](https://velt.dev/docs/api-reference/rest-apis/v2/approval-engine/executions/get-execution.md) with an `executionId` to load the step view models.

## **Example Requests**

#### List running executions for a definition

```JSON theme={null}
{
  "data": {
    "definitionId": "marketing-copy-approval",
    "status": "running",
    "pageSize": 50
  }
}
```

#### Paginate

```JSON theme={null}
{
  "data": {
    "pageSize": 50,
    "cursor": "1777374504364"
  }
}
```

# Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "items": [ /* ExecutionView[], each with steps: [] */ ],
    "nextCursor": "1777374504364"
  }
}
```

Each item carries the same optional `documentId` and `organizationId` fields as [Get Execution](https://velt.dev/docs/api-reference/rest-apis/v2/approval-engine/executions/get-execution.md). A key is omitted when the execution was dispatched without it.

`nextCursor` is `null` when the returned page is not full. Pagination ends there.

#### Failure Response

```JSON theme={null}
{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}
```

```js theme={null}
{
  "result": {
    "items": [],
    "nextCursor": null
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.