Method: projects.tenants.jobs.list

Lists jobs by filter.

HTTP request

GET https://jobs.googleapis.com/v4/{parent=projects/*/tenants/*}/jobs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the tenant under which the job is created.

The format is "projects/{projectId}/tenants/{tenantId}". For example, "projects/foo/tenants/bar".

Query parameters

Parameters
filter

string

Required. The filter string specifies the jobs to be enumerated.

Supported operator: =, AND

The fields eligible for filtering are:

  • companyName
  • requisitionId
  • status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified.

At least one of companyName and requisitionId must present or an INVALID_ARGUMENT error is thrown.

Sample Query:

  • companyName = "projects/foo/tenants/bar/companies/baz"
  • companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1"
  • companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED"
  • requisitionId = "req-1"
  • requisitionId = "req-1" AND status = "EXPIRED"
pageToken

string

The starting point of a query result.
pageSize

integer

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)

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:

List jobs response.

JSON representation 
{
  "jobs": [
    {
      object (Job)
    }
  ],
  "nextPageToken": string,
  "metadata": {
    object (ResponseMetadata)
  }
}
Fields
jobs[]

object (Job)

The Jobs for a given company.

The maximum number of items returned is based on the limit field provided in the request.
nextPageToken

string

A token to retrieve the next page of results.
metadata

object (ResponseMetadata)

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.