GET/schedule

List Schedules

List schedules

Implementation Notes

Retrieves details of one or multiple Schedule based on the provided scheduleId.

GET/schedule

Parameter Details

Name	In	Type	Required	Description
`scheduleId`	query	`integer`	Optional	Unique identifier for the schedules.

Responses

Status	Meaning	Description	Schema
200	OK	OK
400	Bad Request	Bad Request	None
401	Unauthorized	Unauthorized	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 https://api.events.example.com/api/v1/schedule \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "scheduleId": 201,
  "scheduleName": "sample_schedule_name",
  "year": "*",
  "month": "*",
  "dow": "*",
  "day": "*",
  "hour": "*",
  "minute": "20",
  "status": 1,
  "startDate": "2025-03-13",
  "endDate": "2025-03-13",
  "shopType": 3,
  "fetchType": 1,
  "shopId": 0
}

PreviousCreate Schedule

NextUpdate Schedule

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.

Contact Support

About Us