diff --git a/qstash/api/schedules/get.mdx b/qstash/api/schedules/get.mdx
index 5d755ff4..154c7b42 100644
--- a/qstash/api/schedules/get.mdx
+++ b/qstash/api/schedules/get.mdx
@@ -13,17 +13,14 @@ authMethod: "bearer"
## Response
-
- The creation time of the object. UnixMilli
-
The id of the schedule.
The cron expression used to schedule the message.
-
- IP address where this schedule created from.
+
+ The creation time of the object. UnixMilli
Url or URL Group name
@@ -31,12 +28,15 @@ authMethod: "bearer"
The HTTP method to use for the message.
-
+
The headers of the message.
-
+
The body of the message.
+
+ The base64 encoded body of the message.
+
The number of retries that should be attempted in case of delivery failure.
@@ -46,6 +46,45 @@ authMethod: "bearer"
The url where we send a callback to after the message is delivered
+
+ The url where we send a callback to after the message delivery fails
+
+
+ IP address where this schedule was created from.
+
+
+ Whether the schedule is paused or not.
+
+
+ The flow control key for rate limiting.
+
+
+ The maximum number of parallel executions.
+
+
+ The rate limit for this schedule.
+
+
+ The time interval during which the specified rate of requests can be activated using the same flow control key. In seconds.
+
+
+ The retry delay expression for this schedule, if retry_delay was set when creating the schedule.
+
+
+ The label assigned to the schedule for filtering purposes.
+
+
+ The timestamp of the last scheduled execution.
+
+
+ The timestamp of the next scheduled execution.
+
+
+ The states of the last scheduled messages. Maps message id to state (IN_PROGRESS, SUCCESS, FAIL).
+
+
+ The IP address of the caller who created the schedule.
+
@@ -93,16 +132,24 @@ defer resp.Body.Close()
```json 200 OK
{
- "scheduleId": "scd_1234",
- "createdAt": 1623345678001,
- "cron": "0 0 1 * *",
- "destination": "https://example.com",
- "method": "POST",
- "header": {
- "Content-Type": ["application/json"]
+ createdAt: 1754565618803,
+ scheduleId: "schedule-id",
+ cron: "* * * * *",
+ destination: "https://your-website/api",
+ method: "GET",
+ header: {
+ "Content-Type": [ "application/json" ],
+ },
+ retries: 3,
+ delay: 25,
+ lastScheduleTime: 1755095280020,
+ nextScheduleTime: 1759909800000,
+ lastScheduleStates: {
+ msg_7YoJxFpwk: "SUCCESS",
},
- "body": "{\"message\":\"hello\"}",
- "retries": 3
+ callerIP: "127.43.12.54",
+ isPaused: true,
+ parallelism: 0,
}
```
diff --git a/qstash/api/schedules/list.mdx b/qstash/api/schedules/list.mdx
index 70ecd4b2..df7455d9 100644
--- a/qstash/api/schedules/list.mdx
+++ b/qstash/api/schedules/list.mdx
@@ -9,37 +9,75 @@ authMethod: "bearer"
-
- The creation time of the object. UnixMilli
-
-
+
The id of the schedule.
The cron expression used to schedule the message.
+
+ The creation time of the object. UnixMilli
+
Url or URL Group (topic) name
-
The HTTP method to use for the message.
-
+
The headers of the message.
-
+
The body of the message.
-
+
The number of retries that should be attempted in case of delivery failure.
-
+
The delay in seconds before the message is delivered.
-
+
The url where we send a callback to after the message is delivered
+
+ The url where we send a callback to after the message delivery fails
+
+
+ IP address where this schedule was created from.
+
+
+ Whether the schedule is paused or not.
+
+
+ The flow control key for rate limiting.
+
+
+ The maximum number of parallel executions.
+
+
+ The rate limit for this schedule.
+
+
+ The time interval during which the specified rate of requests can be activated using the same flow control key. In seconds.
+
+
+ The retry delay expression for this schedule, if retry_delay was set when creating the schedule.
+
+
+ The label assigned to the schedule for filtering purposes.
+
+
+ The timestamp of the last scheduled execution.
+
+
+ The timestamp of the next scheduled execution.
+
+
+ The states of the last scheduled messages. Maps message id to state (IN_PROGRESS, SUCCESS, FAIL).
+
+
+ The IP address of the caller who created the schedule.
+
@@ -89,16 +127,24 @@ defer resp.Body.Close()
```json 200 OK
[
{
- "scheduleId": "scd_1234",
- "createdAt": 1623345678001,
- "cron": "0 0 1 * *",
- "destination": "https://example.com",
- "method": "POST",
- "header": {
- "Content-Type": ["application/json"]
+ createdAt: 1754565618803,
+ scheduleId: "schedule-id",
+ cron: "* * * * *",
+ destination: "https://your-website/api",
+ method: "GET",
+ header: {
+ "Content-Type": [ "application/json" ],
+ },
+ retries: 3,
+ delay: 25,
+ lastScheduleTime: 1755095280020,
+ nextScheduleTime: 1759909800000,
+ lastScheduleStates: {
+ msg_7YoJxFpwk: "SUCCESS",
},
- "body": "{\"message\":\"hello\"}",
- "retries": 3
+ callerIP: "127.43.12.54",
+ isPaused: true,
+ parallelism: 0,
}
]
```