- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Lists jobs by filter.
HTTP request
GET https://jobs.googleapis.com/v3/{parent=projects/*}/jobs
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent
|
Required. The resource name of the project under which the job is created. The format is "projects/{projectId}", for example, "projects/api-test-project". |
Query parameters
filter
string
Required. The filter string specifies the jobs to be enumerated.
Supported operator: =, AND
The fields eligible for filtering are:
-
companyName(Required) -
requisitionId(Optional)
Sample Query:
- companyName = "projects/api-test-project/companies/123"
- companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1"
pageToken
string
Optional. The starting point of a query result.
pageSize
integer
Optional. The maximum number of jobs to be returned per page of results.
If jobView
is set to JobView.JOB_VIEW_ID_ONLY
, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100.
Default is 100 if empty or a number < 1 is specified.
jobView
enum (
JobView
)
Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL
if no value is specified.
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Output only.
List jobs response.
| JSON representation | |
|---|---|
{ "jobs" : [ { object ( |
|
| Fields | |
|---|---|
jobs[]
|
The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. |
nextPageToken
|
A token to retrieve the next page of results. |
metadata
|
Additional information for the API invocation, such as the request tracking id. |
Authorization Scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/jobs -
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
