GET/schedule/list

Get All Schedules

This API call retrieves the list of schedules defined in your account. You can fetch schedule details for a specific shop by providing the shopId. If no shopId is provided, all schedules will be displayed.

GET/schedule/list

Optional Fields

shopId
schedulesPerPage
pageNumber

Parameter Details

Name	In	Type	Required	Description
`shopId`	query	`integer`	Optional	Enter shopId
`schedulesPerPage`	query	`integer`	Optional	The number of items to display in a page
`pageNumber`	query	`integer`	Optional	Indicates the current page number

Responses

Status	Meaning	Description	Schema
200	OK	Success	`schedulesGetAllResp`
400	Bad Request	Bad Request	None
401	Unauthorized	Authorization Failed	None
500	Internal Server Error	Internal Server Error	None

Example Request

# You can also use wget
curl -X GET /schedule/list \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

Example responses

200 Response

[
  {
    "totalRecords": 2,
    "fetchedRecords": 2,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 10,
    "schedules": [
      {
        "scheduleId": 1,
        "scheduleName": "X-Mas",
        "shopId": 1234,
        "year": "*",
        "month": "*",
        "dow": "*",
        "day": "*",
        "hour": "1",
        "minute": "*",
        "seconds": "*",
        "startDate": "2025-05-06",
        "endDate": "2025-05-06"
      }
    ]
  }
]

PreviousCreate Schedule

NextGet 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