GET/api/v1/schedules

Get Schedules

A schedule is a method to program in time the extractions of shops. For example a shop can be scheduled to extract at 8am every day, or another shop can be extracted on Tuesdays only. This API provides a list and details of all user schedules. Users can access this endpoint to obtain details about each schedule, including the schedule name, year, month, and other relevant information.

Upon a successful request, the system will respond with a JSON object containing all information of all schedules.

GET/api/v1/schedules

Parameter Details

Name	In	Type	Required	Description
`page`	query	`integer`	Optional	The page number to retrieve.
`size`	query	`integer`	Optional	The number of items to be displayed per page.

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/schedules \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

Example responses

200 Response

{
  "error": false,
  "schedules": [
    {
      "_id": "63ff1e0bb2482db1c660e306",
      "scheduleName": "flightrates Schedules",
      "_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"
    }
  ],
  "totalData": 1,
  "totalPages": 1,
  "page": 1,
  "size": 10
}

PreviousBulk Schedule Upload

NextBulk Schedule Sample

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