GET/api/v1/schedule/{scheduleId}

Get Schedule

Get a single Schedule

This API provides details of a specific user schedule. By providing the schedule ID in the request, users can obtain details about the schedule, including the schedule name, year, month, and other relevant information.

Mandatory Fields - "scheduleId"

GET/api/v1/schedule/{scheduleId}

Parameter Details

Name	In	Type	Required	Description
`scheduleId`	path	`string(string)`	Required	Schedule Id

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 https://api.flightrates.example.com/api/v1/schedule/{scheduleId} \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

Example responses

200 Response

{
  "error": false,
  "schedule": {
    "_id": "6a0becec9650dadda773d068",
    "scheduleName": "#1 Flightschedule name",
    "_shop": "6a0bea8e9650dadda773d04b",
    "_timezone": "64ae7e58d06e77f95bff0565",
    "timezoneName": "Europe/Mariehamn",
    "minute": "0",
    "hour": "*",
    "dayOfMonth": "*",
    "month": "*",
    "dayOfWeek": "*",
    "isActiveStatus": true,
    "startDate": "2026-05-19",
    "endDate": "2026-05-19",
    "_user": "6a0aaf8da93611b858a5abf8",
    "userName": "testinbound",
    "vertical": "flightrates",
    "isCustomerCreated": true,
    "crontabExpression": "0 * * * *",
    "nextRunAt": "2026-05-19T06:00:00.000Z",
    "lastRunAt": null,
    "createdAt": "2026-05-19T04:54:04.903Z",
    "updatedAt": "2026-05-19T04:54:04.903Z",
    "crontabHuman": "Every hour, every day",
    "id": "6a0becec9650dadda773d068"
  }
}

PreviousBulk Schedule Download

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