Method: projects.tenants.companies.list

Lists all companies associated with the project.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of the tenant under which the company is created.

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

If tenant id is unspecified, the default tenant will be used, for example, "projects/foo".

Query parameters

Parameters
pageToken

string

The starting indicator from which to return results.

pageSize

integer

The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.

requireOpenJobs

boolean

Set to true if the companies requested must have open jobs.

Defaults to false.

If true, at most pageSize of companies are fetched, among which only those with open jobs are returned.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListCompaniesResponse.

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.