---
title: "Get season plan"
---

> 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/cycles/{cycleId}/plan`

## Path parameters

- `cycleId` (`execution-get-season-plan.path.cycleId`; string, required)
  - format `uuid`

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/execution/cycles/<cycleId>/plan';
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/cycles/<cycleId>/plan"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "cycleId": "811bdbf8-a42f-4f8c-b62e-39c77332ffe1",
    "phases": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
        "cycleId": "811bdbf8-a42f-4f8c-b62e-39c77332ffe1",
        "name": "string",
        "purpose": "string",
        "sequence": 1,
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "milestones": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
        "cycleId": "811bdbf8-a42f-4f8c-b62e-39c77332ffe1",
        "phaseId": "0ad391c4-95b8-47f9-85a6-2edccf8f12cc",
        "title": "string",
        "description": "string",
        "eventAt": "2019-08-24T14:15:22Z",
        "priority": "primary",
        "createdBy": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`execution-get-season-plan.response.200.data`; object, required)
  - `cycleId` (`execution-get-season-plan.response.200.data.cycleId`; string, required)
    - format `uuid`
  - `phases` (`execution-get-season-plan.response.200.data.phases`; array<object>, required)
    - `id` (`execution-get-season-plan.response.200.data.phases.id`; string, required)
      - format `uuid`
    - `entityId` (`execution-get-season-plan.response.200.data.phases.entityId`; string, required)
      - format `uuid`
    - `cycleId` (`execution-get-season-plan.response.200.data.phases.cycleId`; string, required)
      - format `uuid`
    - `name` (`execution-get-season-plan.response.200.data.phases.name`; string, required)
      - minLength 1; maxLength 120
    - `purpose` (`execution-get-season-plan.response.200.data.phases.purpose`; string, required, nullable)
      - minLength 1; maxLength 2000
    - `sequence` (`execution-get-season-plan.response.200.data.phases.sequence`; integer, required)
      - min 1; max 1000
    - `startDate` (`execution-get-season-plan.response.200.data.phases.startDate`; string, required)
      - format `date-time`
    - `endDate` (`execution-get-season-plan.response.200.data.phases.endDate`; string, required)
      - format `date-time`
    - `createdBy` (`execution-get-season-plan.response.200.data.phases.createdBy`; string, required)
      - minLength 1
    - `createdAt` (`execution-get-season-plan.response.200.data.phases.createdAt`; string, required)
      - format `date-time`
    - `updatedAt` (`execution-get-season-plan.response.200.data.phases.updatedAt`; string, required)
      - format `date-time`
  - `milestones` (`execution-get-season-plan.response.200.data.milestones`; array<object>, required)
    - `id` (`execution-get-season-plan.response.200.data.milestones.id`; string, required)
      - format `uuid`
    - `entityId` (`execution-get-season-plan.response.200.data.milestones.entityId`; string, required)
      - format `uuid`
    - `cycleId` (`execution-get-season-plan.response.200.data.milestones.cycleId`; string, required)
      - format `uuid`
    - `phaseId` (`execution-get-season-plan.response.200.data.milestones.phaseId`; string, required, nullable)
      - format `uuid`
    - `title` (`execution-get-season-plan.response.200.data.milestones.title`; string, required)
      - minLength 1; maxLength 160
    - `description` (`execution-get-season-plan.response.200.data.milestones.description`; string, required, nullable)
      - minLength 1; maxLength 4000
    - `eventAt` (`execution-get-season-plan.response.200.data.milestones.eventAt`; string, required)
      - format `date-time`
    - `priority` (`execution-get-season-plan.response.200.data.milestones.priority`; string, required)
      - one of `"primary"`, `"supporting"`, `"exploratory"`
    - `createdBy` (`execution-get-season-plan.response.200.data.milestones.createdBy`; string, required)
      - minLength 1
    - `createdAt` (`execution-get-season-plan.response.200.data.milestones.createdAt`; string, required)
      - format `date-time`
- `meta` (`execution-get-season-plan.response.200.meta`; object, optional)
  - `timestamp` (`execution-get-season-plan.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

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

- `error` (`execution-get-season-plan.response.400.error`; object, required)
  - `code` (`execution-get-season-plan.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.401.error`; object, required)
  - `code` (`execution-get-season-plan.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.403.error`; object, required)
  - `code` (`execution-get-season-plan.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.404.error`; object, required)
  - `code` (`execution-get-season-plan.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.409.error`; object, required)
  - `code` (`execution-get-season-plan.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.422.error`; object, required)
  - `code` (`execution-get-season-plan.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.429.error`; object, required)
  - `code` (`execution-get-season-plan.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.500.error`; object, required)
  - `code` (`execution-get-season-plan.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.502.error`; object, required)
  - `code` (`execution-get-season-plan.response.502.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.502.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.502.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.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-get-season-plan.response.503.error`; object, required)
  - `code` (`execution-get-season-plan.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-season-plan.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-season-plan.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-season-plan.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/execution-get-season-plan/index.md
