[[["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: customJobs.list\n\n**Full name**: projects.locations.customJobs.list\n\nLists CustomJobs in a Location. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1``/{parent}``/customJobs` \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 CustomJobs from. Format: `projects/{project}/locations/{location}`\n\n### Query parameters\n\n`filter` `string` \nThe standard list filter.\n\nSupported fields:\n\n- `displayName` supports `=`, `!=` comparisons, and `:` wildcard.\n- `state` supports `=`, `!=` comparisons.\n- `createTime` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `createTime` must be in RFC 3339 format.\n- `labels` supports general map functions that is: `labels.key=value` - key:value equality \\`labels.key:\\* - key existence\n\nSome examples of using the filter are:\n\n- `state=\"JOB_STATE_SUCCEEDED\" AND displayName:\"my_job_*\"`\n- `state!=\"JOB_STATE_FAILED\" OR displayName=\"my_job\"`\n- `NOT displayName=\"my_job\"`\n- `createTime\u003e\"2021-05-18T00:00:00Z\"`\n- `labels.keyA=valueA`\n- `labels.keyB:*`\n`pageSize` `integer` \nThe standard list page size.\n`pageToken` `string` \nThe standard list page token. Typically obtained via [ListCustomJobsResponse.next_page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.customJobs/list#body.ListCustomJobsResponse.FIELDS.next_page_token) of the previous [JobService.ListCustomJobs](/vertex-ai/docs/reference/rest/v1/projects.locations.customJobs/list#google.cloud.aiplatform.v1.JobService.ListCustomJobs) call.\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 [JobService.ListCustomJobs](/vertex-ai/docs/reference/rest/v1/projects.locations.customJobs/list#google.cloud.aiplatform.v1.JobService.ListCustomJobs)\n\nIf successful, the response body contains data with the following structure:\nFields `customJobs[]` `object (`[CustomJob](/vertex-ai/docs/reference/rest/v1/projects.locations.customJobs#CustomJob)`)` \nList of CustomJobs in the requested page.\n`nextPageToken` `string` \nA token to retrieve the next page of results. Pass to [ListCustomJobsRequest.page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.customJobs/list#body.QUERY_PARAMETERS.page_token) to obtain that page."]]