List Schedules
A maximum of 100 tasks are returned per request.
This is a paginated endpoint. To request the next page, use the value of the X-Cursor-After
header from the previous response as the after
query parameter in the next request.
Authorizations
The Mergent API uses API keys to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Query Parameters
The cursor value from the X-Cursor-After
header of the previous response. Use this to request the next page.
Response
The unique ID for the schedule.
The name of the schedule.
The description of the schedule.
The name of the of the task queue.
A task request.
A cron expression describing when the schedule should be invoked (UTC).
Note: invocation n + 1 of a schedule will not begin until invocation n has completed successfully.
You must pass either cron
or rrule
when creating a new schedule.
An iCal RRule expression describing when the schedule should be invoked (UTC).
Note: invocation n + 1 of a schedule will not begin until invocation n has completed successfully.
You must pass either cron
or rrule
when creating a new schedule.
The ISO 8601 timestamp denoting the start of an RRULE schedule.
When not set, it will be set to the current time, and the schedule will be invoked immediately.
Ignored for cron
-type schedules.
A boolean indicating whether or not the schedule is paused.
The ISO 8601 timestamp for when the schedule is scheduled to be executed.
The ISO 8601 timestamp representing when the schedule was created.
Was this page helpful?