GET
/api/v1/schedule/{scheduleId}Get Schedule
This API provides details of a specific user schedule. By providing the schedule ID in the request, users can obtain details about the schedule, including the schedule name, year, month, and other relevant information.
GET
/api/v1/schedule/{scheduleId}Mandatory Fields
- scheduleId
Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scheduleId | path | string(string) | Required | Schedule Id |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | |
| 400 | Bad Request | Request data failed validation(s) | None |
| 401 | Unauthorized | Authentication Failed! | None |
| 429 | Too Many Requests | Too Many Requests. | None |
| 500 | Internal Server Error | Internal Server Error | None |
Example Request
# You can also use wget
curl -X GET /api/v1/schedule/{scheduleId} \
-H 'Accept: application/json' \
-H 'Authorization: API_KEY'
Example responses
200 Response
{
"error": false,
"schedule": {
"_id": "63ff1e0bb2482db1c660e306",
"scheduleName": "Flightschedule name",
"_shop": "63fdd677a631b4a452c34b24",
"_timezone": "63fdd677a631b4a452c34b22",
"timezoneName": "asia/kol",
"dayOfMonth": "*",
"month": "*",
"dayOfWeek": "*",
"hour": "*",
"minute": "0",
"crontabExpression": "0 * * * *",
"crontabHuman": "Every minute, every hour, every day",
"isActiveStatus": true,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"_user": "63fda531bde67155fc46fb41",
"userName": "user@flightrates.com",
"vertical": "flightrates",
"isCustomerCreated": "true,",
"createdAt": "2023-03-01T09:42:35.372Z",
"updatedAt": "2023-03-03T06:22:55.108Z",
"id": "63ff1e0bb2482db1c660e306"
}
}
Need Support?
Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.