list_schedules

SchedulesApi.list_schedules(role_id, limit=None, offset=None, sortorder=None, sortby=None, projection_expression=None, filter_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List accessible schedules

Returns a paginated list of schedules the caller can access (job/event/ external-trigger and accessible notebook datalab schedules). Use next_available for pagination (offset is 1-based). Default sort is LastModified desc.

Parameters:

• role_id (str) – Amorphic role ID used for authorization. (required)

• limit (int) – Page size. Defaults to 100. Maximum allowed is 1000.

• offset (int) – 1-based page number. offset=1 returns the first page.

• sortorder (str) – Sort direction. Defaults to desc.

• sortby (str) – Field name to sort by. Defaults to LastModified. Only attributes every schedule carries as a string are sortable; anything else is rejected with IPV-1041.

• projection_expression (str) – Comma-separated list of attributes to include in each schedule object. When set, only those attributes are returned for each item.

• filter_expression (str) – Filter as Key:value pairs separated by commas. Repeated keys are OR-ed, distinct keys are AND-ed. Matching is case-insensitive, and null matches an attribute that is absent or null. JobName additionally accepts * wildcards, so a partial search term is sent as JobName:*term*. Filtering is applied before pagination, so count/total_count describe the matches.

• _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:

ScheduledJobStatusList

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /schedules

Parameter examples

Name	In	Example
role_id	header	"role-admin"
limit	query	100
offset	query	1
sortorder	query	"desc"
sortby	query	"LastModified"
projectionExpression	query	"ScheduleId,JobName,State,LastModified,AccessType"
filterExpression	query	"JobName:*etl*,State:ENABLED"

Success (HTTP 200)

Paginated schedule list. Body includes `schedules`, `count`, `total_count`, `next_available` (`yes`|`no`), and `AccountId`.

First page of mixed schedules

{
  "schedules": [
    {
      "ScheduleId": "sch-11111111-aaaa-bbbb-cccc-222222222222",
      "JobName": "nightly-etl",
      "Description": "Nightly ETL",
      "ScheduleType": "time",
      "ScheduleParam": {
        "ScheduleExpression": "cron(0 2 * * ? *)"
      },
      "JobType": "etl",
      "Resource": "job-abcdef12-3456-7890-abcd-ef1234567890",
      "ResourceType": "jobs",
      "Arguments": [],
      "CreatedBy": "user@example.com",
      "CreationTime": "2026-08-01T10:00:00Z",
      "LastModified": "2026-08-10T10:00:00Z",
      "State": "ENABLED",
      "AccessType": "owner",
      "Keywords": []
    }
  ],
  "count": 1,
  "total_count": 1,
  "next_available": "no",
  "AccountId": "123456789012"
}

No accessible schedules

{
  "schedules": [],
  "count": 0,
  "total_count": 0,
  "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 schedules.