GET/schedules/list

List Schedules

This endpoint retrieves a list of list schedules. Use the available filters and pagination parameters to refine your results.

GET/schedules/list

Optional Fields

shopId
schedulesPerPage
pageNumber

Note

For any technical assistance or feature requests, please contact our API support team.

Important Notes

Always use HTTPS for API requests.
Access tokens are valid for a limited time and should be refreshed periodically.
Rate limiting applies to all endpoints to ensure system stability.

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

pageNumber: Specifies the page of results to retrieve. Default is 1.
All parameters should be formatted according to the types specified in the table above.

Responses

Status	Meaning	Description	Schema
200	OK	Success	`Inline`
400	Bad Request	Bad Request	None
401	Unauthorized	Authorization Failed	None
429	Too Many Requests	Too Many Requests	None
500	Internal Server Error	Internal Server Error	None

Response Notes

The response will include a status field indicating success or failure, along with the requested data or relevant error messages. Standard HTTP status codes are used to indicate the outcome of the request.

Example Request

# You can also use wget
curl -X GET /schedules/list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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": "00",
        "startDate": "2019-08-24",
        "endDate": "2019-08-24"
      }
    ]
  }
]

PreviousCreate Schedule

NextGet Schedule By Id

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