---
title: "List cycles"
---

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

Path: Sureshake API › execution

`GET /v2/execution/{entityId}/cycles`

## Path parameters

- `entityId` (`execution-list-cycles.path.entityId`; string, required)
  - format `uuid`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sureshake.com/v2/execution/<entityId>/cycles'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/execution/<entityId>/cycles';
const options = {method: 'GET'};

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

### Python

```python
import requests

url = "https://api.sureshake.com/v2/execution/<entityId>/cycles"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
      "label": "string",
      "cycleType": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "status": "planning",
      "baselineId": "021a9d20-deb5-4bc7-8aee-9e5074855731",
      "primaryOutcome": "string",
      "ownerUserId": "string",
      "cadence": "weekly",
      "visibility": "public",
      "durationMode": "eight_week_template",
      "durationTemplate": "eight_week",
      "activatedBy": "string",
      "activatedAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true,
    "page": 0,
    "totalPages": 0
  }
}
```

- `data` (`execution-list-cycles.response.200.data`; array<object>, required)
  - `id` (`execution-list-cycles.response.200.data.id`; string, required)
    - format `uuid`
  - `entityId` (`execution-list-cycles.response.200.data.entityId`; string, required)
    - format `uuid`
  - `label` (`execution-list-cycles.response.200.data.label`; string, required)
    - minLength 1; maxLength 120
  - `cycleType` (`execution-list-cycles.response.200.data.cycleType`; string, required)
  - `startDate` (`execution-list-cycles.response.200.data.startDate`; string, required)
    - format `date-time`
  - `endDate` (`execution-list-cycles.response.200.data.endDate`; string, required)
    - format `date-time`
  - `status` (`execution-list-cycles.response.200.data.status`; string, required)
    - one of `"planning"`, `"locked"`, `"active"`, `"resolution_open"`, `"closed"`, `"paused"`, `"reset"`, `"completed"`, `"ended_early"`, `"archived"`
  - `baselineId` (`execution-list-cycles.response.200.data.baselineId`; string, required, nullable)
    - format `uuid`
  - `primaryOutcome` (`execution-list-cycles.response.200.data.primaryOutcome`; string, required, nullable)
    - minLength 1; maxLength 4000
  - `ownerUserId` (`execution-list-cycles.response.200.data.ownerUserId`; string, required, nullable)
    - minLength 1
  - `cadence` (`execution-list-cycles.response.200.data.cadence`; string, required, nullable)
    - one of `"weekly"`, `"biweekly"`, `"monthly"`
  - `visibility` (`execution-list-cycles.response.200.data.visibility`; string, required, nullable)
    - one of `"public"`, `"follower"`, `"capital"`, `"diligence"`, `"custom"`
  - `durationMode` (`execution-list-cycles.response.200.data.durationMode`; string, required, nullable)
    - one of `"eight_week_template"`, `"custom"`
  - `durationTemplate` (`execution-list-cycles.response.200.data.durationTemplate`; string, required, nullable)
    - one of `"eight_week"`
  - `activatedBy` (`execution-list-cycles.response.200.data.activatedBy`; string, required, nullable)
    - minLength 1
  - `activatedAt` (`execution-list-cycles.response.200.data.activatedAt`; string, required, nullable)
    - format `date-time`
  - `createdBy` (`execution-list-cycles.response.200.data.createdBy`; string, required, nullable)
    - minLength 1
  - `createdAt` (`execution-list-cycles.response.200.data.createdAt`; string, required)
    - format `date-time`
  - `updatedAt` (`execution-list-cycles.response.200.data.updatedAt`; string, required)
    - format `date-time`
- `meta` (`execution-list-cycles.response.200.meta`; object, required)
  - `total` (`execution-list-cycles.response.200.meta.total`; number, required) — Total number of items available
  - `limit` (`execution-list-cycles.response.200.meta.limit`; number, required) — Number of items per page
  - `offset` (`execution-list-cycles.response.200.meta.offset`; number, required) — Number of items skipped
  - `hasMore` (`execution-list-cycles.response.200.meta.hasMore`; boolean, required) — Whether more items are available
  - `page` (`execution-list-cycles.response.200.meta.page`; number, optional) — Current page number
  - `totalPages` (`execution-list-cycles.response.200.meta.totalPages`; number, optional) — Total number of pages

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.400.error`; object, required)
  - `code` (`execution-list-cycles.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.401.error`; object, required)
  - `code` (`execution-list-cycles.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.403.error`; object, required)
  - `code` (`execution-list-cycles.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.404.error`; object, required)
  - `code` (`execution-list-cycles.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.409.error`; object, required)
  - `code` (`execution-list-cycles.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 422

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.422.error`; object, required)
  - `code` (`execution-list-cycles.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.422.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.429.error`; object, required)
  - `code` (`execution-list-cycles.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.500.error`; object, required)
  - `code` (`execution-list-cycles.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 502

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.502.error`; object, required)
  - `code` (`execution-list-cycles.response.502.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.502.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.502.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.502.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`execution-list-cycles.response.503.error`; object, required)
  - `code` (`execution-list-cycles.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-list-cycles.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`execution-list-cycles.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-list-cycles.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/execution-list-cycles/index.md