To list the jobs of a project in a region, we recommend usingprojects.locations.jobs.listwith aregional endpoint. To list the all jobs across all regions, useprojects.jobs.aggregated. Usingprojects.jobs.listis not recommended, because you can only get the list of jobs that are running inus-central1.
projects.locations.jobs.listandprojects.jobs.listsupport filtering the list of jobs by name. Filtering by name isn't supported byprojects.jobs.aggregated.
HTTP request
GET https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs
Deprecated. jobs.list always returns summaries now. Use jobs.get for other JobViews.
pageSize
integer
If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.
pageToken
string
Set this to the 'nextPageToken' field of a previous response to request additional results in a long list.
name
string
Optional. The job name.
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance ofListJobsResponse.
[[["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-04-30 UTC."],[[["\u003cp\u003e\u003ccode\u003eprojects.locations.jobs.list\u003c/code\u003e is the recommended method for listing jobs within a specific region, utilizing a regional endpoint.\u003c/p\u003e\n"],["\u003cp\u003eTo list jobs across all regions, use \u003ccode\u003eprojects.jobs.aggregated\u003c/code\u003e; filtering by name is not supported with this method.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eprojects.jobs.list\u003c/code\u003e is not recommended for listing jobs, as it only retrieves jobs running in the \u003ccode\u003eus-central1\u003c/code\u003e region.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to list project jobs in a location uses the \u003ccode\u003eGET\u003c/code\u003e method on a specific URL, requiring a \u003ccode\u003eprojectId\u003c/code\u003e and \u003ccode\u003elocation\u003c/code\u003e as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eVarious query parameters like \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e can be used to refine the list of jobs returned.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.jobs.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList the jobs of a project.\n\nTo list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint](https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`.\n\n`projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`.\n\n### HTTP request\n\n`GET https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListJobsResponse](/dataflow/docs/reference/rest/v1b3/ListJobsResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/compute`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
