get_schedule_executions¶
- SchedulesApi.get_schedule_executions(role_id, id, limit=None, offset=None, sortorder=None, sortby=None, from_time=None, to_time=None, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
List schedule executions
Returns a paginated list of executions for the schedule.
- Parameters:
role_id (str) – Amorphic role ID used for authorization. (required)
id (str) – Schedule ID whose executions to list. (required)
limit (int) – Page size. Defaults to 100. Maximum allowed is 1000 (returns GE-1028 if exceeded).
offset (int) – 1-based page number. offset=1 returns the first page. When omitted, the first page is returned.
sortorder (str) – Sort direction. Defaults to desc.
sortby (str) – Field to sort by. Only EndTime is supported
from_time (str) – Start of EndTime filter window. Must be provided together with to_time.
to_time (str) – End of EndTime filter window. Must be provided together with from_time.
projection_expression (str) – Comma-separated attributes to include on each execution object.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Return type:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: GET /schedules/{id}/executions
Parameter examples¶
Name |
In |
Example |
|---|---|---|
|
header |
|
|
path |
|
|
query |
|
|
query |
|
|
query |
|
|
query |
|
|
query |
|
|
query |
|
|
query |
|
Success (HTTP 200)¶
Paginated execution list. Body includes `executions`, `count`, `total_count`, `next_available` (`yes`|`no`), and `AccountId`.
First page of executions
{
"executions": [
{
"ScheduleId": "sch-11111111-aaaa-bbbb-cccc-222222222222",
"ExecutionId": "exe-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"Resource": "my-etl-job",
"JobType": "etl",
"State": "SUCCEEDED",
"Message": "Job completed",
"StartTime": "2026-08-14 02:00:00",
"EndTime": "2026-08-14 02:12:00"
}
],
"count": 1,
"total_count": 1,
"next_available": "no",
"AccountId": "123456789012"
}
Errors¶
Documented error codes: GE-1028.
HTTP 400
Validation or authorization failure.
limitTooLarge
{
"Message": "GE-1028 - Out of range for items per page, Limit is 1000"
}
HTTP 500
Unexpected server error while listing executions.