We’ve made the difficult decision to sunset Hire by Google on September 1, 2020. Learn more.

Method: tenants.candidates.list

List the candidates in Hire.

HTTP request

GET https://hire.googleapis.com/v1beta1/{parent=tenants/*}/candidates

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The name of the tenant to list candidates on. We accept "my_tenant" as a valid tenant if the account only has access to one tenant. A valid parent would be "tenants/my_tenant".

Query parameters

Parameters
pageSize

number

The maximum number of items to return. Acceptable values are 1 to 100. Defaults to 100.

pageToken

string

Optional pagination token returned in a previous request.

filter

string

Optional filter on candidate fields. Supported dimensions for querying are as follows:

  • applications.status.state=[Application.Status.State]

Attempts to query with an unrecognized filter dimension will result in an INVALID_ARGUMENT error. Sample Query:

  • applications.status.state=ACCEPTED

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response containing a list of candidates for a specific request.

JSON representation
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "nextPageToken": string
}
Fields
candidates[]

object (Candidate)

The list of candidates matching the provided filter.

nextPageToken

string

Token used to access the next page of this result. Omitted if no further results are available. Token can be used up to 6 hours after the original ListCandidatesRequest. Note that in some rare cases token might become invalid before.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/hire.candidate.readonly

For more information, see the OAuth 2.0 Overview.