Method: projects.companies.list

Lists all companies associated with the service account.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

The format is "projects/{projectId}", for example, "projects/api-test-project".

Query parameters

Parameters
pageToken

string

Optional. The starting indicator from which to return results.
pageSize

integer

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

boolean

Optional. 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 data with the following structure:

Output only.

The List companies response object.

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

object (Company)

Companies for the current client.
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.