GOgoogle
projects

GET /v4/projects/{projectsId}/tenants/{tenantsId}/jobs

Lists jobs by filter.

Request

  • Base URL
    https://jobs.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/jobs
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/jobs

Path parameters

projectsIdstring required
tenantsIdstring required

Query parameters

filterstring

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"

jobView'JOB_VIEW_UNSPECIFIED' | 'JOB_VIEW_ID_ONLY' | 'JOB_VIEW_MINIMAL' | 'JOB_VIEW_SMALL' | 'JOB_VIEW_FULL'

The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.

pageSizeinteger

The maximum number of jobs to be returned per page of results. If job_view 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.

pageTokenstring

The starting point of a query result.

Response

Successful response

nextPageTokenstring

A token to retrieve the next page of results.

Changes

No recorded changes to this operation across all 4 revisions of this API.