---
title: "Get review prompt"
---

> 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}/review-prompt`

## Path parameters

- `cycleId` (`execution-get-review-prompt.path.cycleId`; string, required)
  - format `uuid`

## Code samples

### cURL

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

### TypeScript

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

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "cycleId": "811bdbf8-a42f-4f8c-b62e-39c77332ffe1",
    "status": "disabled",
    "schedule": {
      "enabled": true,
      "cadence": "weekly",
      "dayOfWeek": 6,
      "localTime": "string",
      "timeZone": "string",
      "configuredBy": "string",
      "configuredAt": "2019-08-24T14:15:22Z"
    },
    "scheduledAt": "2019-08-24T14:15:22Z",
    "nextScheduledAt": "2019-08-24T14:15:22Z",
    "periodStart": "2019-08-24T14:15:22Z",
    "periodEndExclusive": "2019-08-24T14:15:22Z",
    "title": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`execution-get-review-prompt.response.200.data`; object, required)
  - `cycleId` (`execution-get-review-prompt.response.200.data.cycleId`; string, required)
    - format `uuid`
  - `status` (`execution-get-review-prompt.response.200.data.status`; string, required)
    - one of `"disabled"`, `"inactive"`, `"upcoming"`, `"due"`
  - `schedule` (`execution-get-review-prompt.response.200.data.schedule`; object, required)
    - `enabled` (`execution-get-review-prompt.response.200.data.schedule.enabled`; boolean, required)
    - `cadence` (`execution-get-review-prompt.response.200.data.schedule.cadence`; string, required)
      - one of `"weekly"`, `"biweekly"`, `"monthly"`
    - `dayOfWeek` (`execution-get-review-prompt.response.200.data.schedule.dayOfWeek`; integer, required)
      - min 0; max 6
    - `localTime` (`execution-get-review-prompt.response.200.data.schedule.localTime`; string, required)
      - pattern `^([01][0-9]|2[0-3]):[0-5][0-9]$`
    - `timeZone` (`execution-get-review-prompt.response.200.data.schedule.timeZone`; string, required)
      - minLength 1; maxLength 100
    - `configuredBy` (`execution-get-review-prompt.response.200.data.schedule.configuredBy`; string, required, nullable)
      - minLength 1
    - `configuredAt` (`execution-get-review-prompt.response.200.data.schedule.configuredAt`; string, required, nullable)
      - format `date-time`
  - `scheduledAt` (`execution-get-review-prompt.response.200.data.scheduledAt`; string, required, nullable)
    - format `date-time`
  - `nextScheduledAt` (`execution-get-review-prompt.response.200.data.nextScheduledAt`; string, required, nullable)
    - format `date-time`
  - `periodStart` (`execution-get-review-prompt.response.200.data.periodStart`; string, required, nullable)
    - format `date-time`
  - `periodEndExclusive` (`execution-get-review-prompt.response.200.data.periodEndExclusive`; string, required, nullable)
    - format `date-time`
  - `title` (`execution-get-review-prompt.response.200.data.title`; string, required)
    - minLength 1
  - `message` (`execution-get-review-prompt.response.200.data.message`; string, required)
    - minLength 1
- `meta` (`execution-get-review-prompt.response.200.meta`; object, optional)
  - `timestamp` (`execution-get-review-prompt.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-review-prompt.response.400.error`; object, required)
  - `code` (`execution-get-review-prompt.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.401.error`; object, required)
  - `code` (`execution-get-review-prompt.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.403.error`; object, required)
  - `code` (`execution-get-review-prompt.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.404.error`; object, required)
  - `code` (`execution-get-review-prompt.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.409.error`; object, required)
  - `code` (`execution-get-review-prompt.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.422.error`; object, required)
  - `code` (`execution-get-review-prompt.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.429.error`; object, required)
  - `code` (`execution-get-review-prompt.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.500.error`; object, required)
  - `code` (`execution-get-review-prompt.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.502.error`; object, required)
  - `code` (`execution-get-review-prompt.response.502.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.502.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.502.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.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-review-prompt.response.503.error`; object, required)
  - `code` (`execution-get-review-prompt.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`execution-get-review-prompt.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`execution-get-review-prompt.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`execution-get-review-prompt.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/execution-get-review-prompt/index.md