GET/schedules/list

List 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, schedules for all shops will be returned.

GET/schedules/list

Parameter Details

Name	In	Type	Required	Description
`shopId`	query	`integer`	Optional	The identifier of the shop for which to retrieve schedules. If omitted, schedules for all shops will be shown.
`schedulesPerPage`	query	`integer`	Optional	Specifies the number of schedule records to display per page, helping to limit the number of records fetched at once.
`pageNumber`	query	`integer`	Optional	Determines which page of results to view.

pageNumber: Specifies the page of results to retrieve. Default is 1.

Responses

Status	Meaning	Description	Schema
200	OK	Success
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

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

About Us