---
title: "List and search a project's runs"
description: "Newest first (createdAt, then id, descending), from the run list, which lags changes by about a second; a get by ID always reads the run itself. Every filter is optional and they combine with AND; repeat status to match any of several. There are no counts: page with nextCursor (\"Load more\"). The list is unavailable (503 with Retry-After) while its store is; nothing else is affected."
---

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

Path: Workflows API

`GET /v1/organizations/{orgId}/projects/{projectId}/runs`

Newest first (createdAt, then id, descending), from the run list, which lags changes by about a second; a get by ID always reads the run itself. Every filter is optional and they combine with AND; repeat status to match any of several. There are no counts: page with nextCursor ("Load more"). The list is unavailable (503 with Retry-After) while its store is; nothing else is affected.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `ListRuns.path.orgId` (string, required)
  - format `uuid`
- `ListRuns.path.projectId` (string, required)
  - format `uuid`

## Query parameters

- `ListRuns.query.appId` (string, optional) — Only this app's runs.
  - format `uuid`
- `ListRuns.query.workflow` (string, optional) — Only this workflow's runs.
  - pattern `^[A-Za-z0-9_-]{1,64}$`
- `ListRuns.query.status` (array<string>, optional) — Only runs in one of these statuses (repeat the parameter for several).
- `ListRuns.query.scheduleId` (string, optional) — Only runs this schedule started (its firings and triggers).
  - format `uuid`
- `ListRuns.query.parentRunId` (string, optional) — Only the child runs this run started with step.invoke.
  - format `uuid`
- `ListRuns.query.runKey` (string, optional) — Only the run with this runKey (exact match).
  - pattern `^[A-Za-z0-9._:-]{1,128}$`
- `ListRuns.query.createdAfter` (string, optional) — Only runs created after this instant (exclusive). RFC 3339, at most millisecond precision.
  - format `date-time`
- `ListRuns.query.createdBefore` (string, optional) — Only runs created before this instant (exclusive). RFC 3339, at most millisecond precision.
  - format `date-time`
- `ListRuns.query.limit` (integer, optional) — The page size. Out of range is 400, never a clamp.
  - min 1; max 100; default `50`
- `ListRuns.query.cursor` (string, optional) — The previous page's nextCursor. Bound to the organization, the list and its filters.

## Code samples

### cURL

```curl
curl --request GET \
  --url https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://workflows-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

A page of runs, newest first.

#### Example

```json
{
  "nextCursor": "string",
  "runs": [
    {
      "appId": "28c365d5-df94-4a54-8217-3ce51d068868",
      "attempt": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "endedAt": "2019-08-24T14:15:22Z",
      "error": {
        "code": "string",
        "name": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "parentRunId": "c21598d9-9e11-4929-a44f-027d54e71332",
      "runKey": "string",
      "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
      "scheduledTime": "2019-08-24T14:15:22Z",
      "status": "running",
      "updatedAt": "2019-08-24T14:15:22Z",
      "workflow": "string"
    }
  ]
}
```

- `ListRuns.response.200.nextCursor` (string | null, required)
- `ListRuns.response.200.runs` (array<object>, required)
  - `ListRuns.response.200.runs.appId` (string, required)
    - format `uuid`
  - `ListRuns.response.200.runs.attempt` (integer, required)
  - `ListRuns.response.200.runs.createdAt` (string, required)
    - format `date-time`
  - `ListRuns.response.200.runs.endedAt` (string | null, required)
    - format `date-time`
  - `ListRuns.response.200.runs.error` (object | null, required)
    - `ListRuns.response.200.runs.error.code` (string, required)
    - `ListRuns.response.200.runs.error.name` (string, required)
  - `ListRuns.response.200.runs.id` (string, required)
    - format `uuid`
  - `ListRuns.response.200.runs.parentRunId` (string | null, required) — The run whose step.invoke started this one.
    - format `uuid`
  - `ListRuns.response.200.runs.runKey` (string | null, required)
  - `ListRuns.response.200.runs.scheduleId` (string | null, required) — The schedule that started the run.
    - format `uuid`
  - `ListRuns.response.200.runs.scheduledTime` (string | null, required) — The firing's scheduled time, for a run a schedule started.
    - format `date-time`
  - `ListRuns.response.200.runs.status` (string, required)
    - one of `"running"`, `"cancelling"`, `"completed"`, `"failed"`, `"cancelled"`, `"timedOut"`
  - `ListRuns.response.200.runs.updatedAt` (string, required) — When a listed field (status, attempt, end, error) last changed.
    - format `date-time`
  - `ListRuns.response.200.runs.workflow` (string, required)

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListRuns.response.400.error` (object, required)
  - `ListRuns.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListRuns.response.400.error.message` (string, required)
    - maxLength 1024
  - `ListRuns.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListRuns.response.400.error.issues.message` (string, required)
    - `ListRuns.response.400.error.issues.path` (string, required)
  - `ListRuns.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListRuns.response.400.error.quota.id` (string, required)
    - `ListRuns.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListRuns.response.400.error.quota.limit` (integer, required)
      - min 0
    - `ListRuns.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListRuns.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListRuns.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListRuns.response.400.error.quota.region` (string, optional)
    - `ListRuns.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListRuns.response.400.error.quota.scopeResourceName` (string, optional)
    - `ListRuns.response.400.error.quota.used` (integer, optional)
      - min 0
    - `ListRuns.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListRuns.response.401.error` (object, required)
  - `ListRuns.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListRuns.response.401.error.message` (string, required)
    - maxLength 1024
  - `ListRuns.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListRuns.response.401.error.issues.message` (string, required)
    - `ListRuns.response.401.error.issues.path` (string, required)
  - `ListRuns.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListRuns.response.401.error.quota.id` (string, required)
    - `ListRuns.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListRuns.response.401.error.quota.limit` (integer, required)
      - min 0
    - `ListRuns.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListRuns.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListRuns.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListRuns.response.401.error.quota.region` (string, optional)
    - `ListRuns.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListRuns.response.401.error.quota.scopeResourceName` (string, optional)
    - `ListRuns.response.401.error.quota.used` (integer, optional)
      - min 0
    - `ListRuns.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListRuns.response.403.error` (object, required)
  - `ListRuns.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListRuns.response.403.error.message` (string, required)
    - maxLength 1024
  - `ListRuns.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListRuns.response.403.error.issues.message` (string, required)
    - `ListRuns.response.403.error.issues.path` (string, required)
  - `ListRuns.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListRuns.response.403.error.quota.id` (string, required)
    - `ListRuns.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListRuns.response.403.error.quota.limit` (integer, required)
      - min 0
    - `ListRuns.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListRuns.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListRuns.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListRuns.response.403.error.quota.region` (string, optional)
    - `ListRuns.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListRuns.response.403.error.quota.scopeResourceName` (string, optional)
    - `ListRuns.response.403.error.quota.used` (integer, optional)
      - min 0
    - `ListRuns.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListRuns.response.404.error` (object, required)
  - `ListRuns.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListRuns.response.404.error.message` (string, required)
    - maxLength 1024
  - `ListRuns.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListRuns.response.404.error.issues.message` (string, required)
    - `ListRuns.response.404.error.issues.path` (string, required)
  - `ListRuns.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListRuns.response.404.error.quota.id` (string, required)
    - `ListRuns.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListRuns.response.404.error.quota.limit` (integer, required)
      - min 0
    - `ListRuns.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListRuns.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListRuns.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListRuns.response.404.error.quota.region` (string, optional)
    - `ListRuns.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListRuns.response.404.error.quota.scopeResourceName` (string, optional)
    - `ListRuns.response.404.error.quota.used` (integer, optional)
      - min 0
    - `ListRuns.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListRuns.response.429.error` (object, required)
  - `ListRuns.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListRuns.response.429.error.message` (string, required)
    - maxLength 1024
  - `ListRuns.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListRuns.response.429.error.issues.message` (string, required)
    - `ListRuns.response.429.error.issues.path` (string, required)
  - `ListRuns.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListRuns.response.429.error.quota.id` (string, required)
    - `ListRuns.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListRuns.response.429.error.quota.limit` (integer, required)
      - min 0
    - `ListRuns.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListRuns.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListRuns.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListRuns.response.429.error.quota.region` (string, optional)
    - `ListRuns.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListRuns.response.429.error.quota.scopeResourceName` (string, optional)
    - `ListRuns.response.429.error.quota.used` (integer, optional)
      - min 0
    - `ListRuns.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListRuns.response.500.error` (object, required)
  - `ListRuns.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListRuns.response.500.error.message` (string, required)
    - maxLength 1024
  - `ListRuns.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListRuns.response.500.error.issues.message` (string, required)
    - `ListRuns.response.500.error.issues.path` (string, required)
  - `ListRuns.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListRuns.response.500.error.quota.id` (string, required)
    - `ListRuns.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListRuns.response.500.error.quota.limit` (integer, required)
      - min 0
    - `ListRuns.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListRuns.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListRuns.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListRuns.response.500.error.quota.region` (string, optional)
    - `ListRuns.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListRuns.response.500.error.quota.scopeResourceName` (string, optional)
    - `ListRuns.response.500.error.quota.used` (integer, optional)
      - min 0
    - `ListRuns.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListRuns.response.503.error` (object, required)
  - `ListRuns.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListRuns.response.503.error.message` (string, required)
    - maxLength 1024
  - `ListRuns.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListRuns.response.503.error.issues.message` (string, required)
    - `ListRuns.response.503.error.issues.path` (string, required)
  - `ListRuns.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListRuns.response.503.error.quota.id` (string, required)
    - `ListRuns.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListRuns.response.503.error.quota.limit` (integer, required)
      - min 0
    - `ListRuns.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListRuns.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListRuns.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListRuns.response.503.error.quota.region` (string, optional)
    - `ListRuns.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListRuns.response.503.error.quota.scopeResourceName` (string, optional)
    - `ListRuns.response.503.error.quota.used` (integer, optional)
      - min 0
    - `ListRuns.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/workflows-api/ListRuns/index.md