Required. The resource name of the Location to list the PipelineJobs from. Format: projects/{project}/locations/{location}
Query parameters
filter
string
Lists the PipelineJobs that match the filter expression. The following fields are supported:
pipelineName: Supports = and != comparisons.
displayName: Supports =, != comparisons, and : wildcard.
pipelineJobUserId: Supports =, != comparisons, and : wildcard. for example, can check if pipeline's displayName contains step by doing displayName:"*step*"
state: Supports = and != comparisons.
createTime: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
updateTime: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
endTime: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
labels: Supports key-value equality and key presence.
templateUri: Supports =, != comparisons, and : wildcard.
templateMetadata.version: Supports =, != comparisons, and : wildcard.
Filter expressions can be combined together using logical operators (AND & OR). For example: pipelineName="test" AND createTime>"2020-05-18T13:30:00Z".
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 e.g. "createTime desc, endTime", "endTime, startTime, updateTime" For example, using "createTime desc, endTime" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if orderBy is not specified, it will order by default order is create time in descending order. Supported fields:
[[["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: pipelineJobs.list\n\n**Full name**: projects.locations.pipelineJobs.list\n\nLists PipelineJobs in a Location. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1``/{parent}``/pipelineJobs` \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 PipelineJobs from. Format: `projects/{project}/locations/{location}`\n\n### Query parameters\n\n`filter` `string` \nLists the PipelineJobs that match the filter expression. The following fields are supported:\n\n- `pipelineName`: Supports `=` and `!=` comparisons.\n- `displayName`: Supports `=`, `!=` comparisons, and `:` wildcard.\n- `pipelineJobUserId`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's displayName contains *step* by doing displayName:\"\\*step\\*\"\n- `state`: Supports `=` and `!=` comparisons.\n- `createTime`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n- `updateTime`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n- `endTime`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n- `labels`: Supports key-value equality and key presence.\n- `templateUri`: Supports `=`, `!=` comparisons, and `:` wildcard.\n- `templateMetadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard.\n\nFilter expressions can be combined together using logical operators (`AND` \\& `OR`). For example: `pipelineName=\"test\" AND createTime\u003e\"2020-05-18T13:30:00Z\"`.\n\nThe syntax to define filter expression is based on \u003chttps://google.aip.dev/160\u003e.\n\nExamples:\n\n- `createTime\u003e\"2021-05-18T00:00:00Z\" OR\n updateTime\u003e\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC.\n- `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".\n`pageSize` `integer` \nThe standard list page size.\n`pageToken` `string` \nThe standard list page token. Typically obtained via [ListPipelineJobsResponse.next_page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs/list#body.ListPipelineJobsResponse.FIELDS.next_page_token) of the previous [PipelineService.ListPipelineJobs](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs/list#google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs) 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 e.g. \"createTime desc, endTime\", \"endTime, startTime, updateTime\" For example, using \"createTime desc, endTime\" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if orderBy is not specified, it will order by default order is create time in descending order. Supported fields:\n\n- `createTime`\n- `updateTime`\n- `endTime`\n- `startTime`\n`readMask` `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` \nMask specifying which fields to read.\n\nThis is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`.\n\n### Request body\n\nThe request body must be empty. \n\n### Response body\n\nResponse message for [PipelineService.ListPipelineJobs](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs/list#google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs)\n\nIf successful, the response body contains data with the following structure:\nFields `pipelineJobs[]` `object (`[PipelineJob](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs#PipelineJob)`)` \nList of PipelineJobs in the requested page.\n`nextPageToken` `string` \nA token to retrieve the next page of results. Pass to [ListPipelineJobsRequest.page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs/list#body.QUERY_PARAMETERS.page_token) to obtain that page."]]
