Required. The resource name of the Location to list the Schedules from. Format: projects/{project}/locations/{location}
Query parameters
filter
string
Lists the Schedules that match the filter expression. The following fields are supported:
displayName: Supports =, != comparisons, and : wildcard.
state: Supports = and != comparisons.
request: Supports existence of the check. (e.g. createPipelineJobRequest:* --> Schedule has createPipelineJobRequest).
createTime: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
startTime: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
endTime: Supports =, !=, <, >, <=, >= comparisons and :* existence check. Values must be in RFC 3339 format.
nextRunTime: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
Filter expressions can be combined together using logical operators (NOT, AND & OR). The syntax to define filter expression is based on https://google.aip.dev/160.
Examples:
state="ACTIVE" AND displayName:"my_schedule_*"
NOT displayName="my_schedule"
createTime>"2021-05-18T00:00:00Z"
endTime>"2021-05-18T00:00:00Z" OR NOT endTime:*
createPipelineJobRequest:*
pageSize
integer
The standard list page size. Default to 100 if not specified.
A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple orderBy fields provided.
For example, using "createTime desc, endTime" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order.
If orderBy is not specified, it will order by default with createTime in descending order.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: schedules.list\n\n**Full name**: projects.locations.schedules.list\n\nLists Schedules in a Location. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1``/{parent}``/schedules` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`parent` `string` \nRequired. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`\n\n### Query parameters\n\n`filter` `string` \nLists the Schedules that match the filter expression. The following fields are supported:\n\n- `displayName`: Supports `=`, `!=` comparisons, and `:` wildcard.\n- `state`: Supports `=` and `!=` comparisons.\n- `request`: Supports existence of the check. (e.g. `createPipelineJobRequest:*` --\\\u003e Schedule has createPipelineJobRequest).\n- `createTime`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n- `startTime`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n- `endTime`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, `\u003e=` comparisons and `:*` existence check. Values must be in RFC 3339 format.\n- `nextRunTime`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n\nFilter expressions can be combined together using logical operators (`NOT`, `AND` \\& `OR`). The syntax to define filter expression is based on \u003chttps://google.aip.dev/160\u003e.\n\nExamples:\n\n- `state=\"ACTIVE\" AND displayName:\"my_schedule_*\"`\n- `NOT displayName=\"my_schedule\"`\n- `createTime\u003e\"2021-05-18T00:00:00Z\"`\n- `endTime\u003e\"2021-05-18T00:00:00Z\" OR NOT endTime:*`\n- `createPipelineJobRequest:*`\n`pageSize` `integer` \nThe standard list page size. Default to 100 if not specified.\n`pageToken` `string` \nThe standard list page token. Typically obtained via [ListSchedulesResponse.next_page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules/list#body.ListSchedulesResponse.FIELDS.next_page_token) of the previous [ScheduleService.ListSchedules](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules/list#google.cloud.aiplatform.v1.ScheduleService.ListSchedules) call.\n`orderBy` `string` \nA comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple orderBy fields provided.\n\nFor example, using \"createTime desc, endTime\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order.\n\nIf orderBy is not specified, it will order by default with createTime in descending order.\n\nSupported fields:\n\n- `createTime`\n- `startTime`\n- `endTime`\n- `nextRunTime`\n\n### Request body\n\nThe request body must be empty. \n\n### Response body\n\nResponse message for [ScheduleService.ListSchedules](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules/list#google.cloud.aiplatform.v1.ScheduleService.ListSchedules)\n\nIf successful, the response body contains data with the following structure:\nFields `schedules[]` `object (`[Schedule](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules#Schedule)`)` \nList of Schedules in the requested page.\n`nextPageToken` `string` \nA token to retrieve the next page of results. Pass to [ListSchedulesRequest.page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules/list#body.QUERY_PARAMETERS.page_token) to obtain that page."]]
