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

REST Resource: tenants.candidates

Resource: Candidate

A candidate in Hire.

JSON representation
{
  "name": string,
  "createTime": string,
  "personName": {
    object (PersonName)
  },
  "email": string,
  "additionalEmails": [
    string
  ],
  "uris": [
    string
  ],
  "phoneNumber": string,
  "additionalPhoneNumbers": [
    string
  ],
  "postalAddresses": [
    {
      object (PostalAddress)
    }
  ],
  "employmentInfo": [
    {
      object (EmploymentInfo)
    }
  ],
  "educationInfo": [
    {
      object (EducationInfo)
    }
  ],
  "source": {
    object (Source)
  },
  "visaAssistanceInfo": {
    object (VisaAssistanceInfo)
  },
  "startDate": {
    object (Date)
  },
  "applications": [
    string
  ]
}
Fields
name

string

The resource name of this Candidate. Candidate name takes the form of "tenants/*/candidates/*".

createTime

string (Timestamp format)

Timestamp when the candidate record was created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

personName

object (PersonName)

Name of the candidate.

email

string

Candidate's primary email address.

additionalEmails[]

string

Candidate's other email addresses.

uris[]

string

A list of the candidate's URIs for example a URL for a personal website, a digital-portfolio, or a LinkedIn profile.

Max string length is 2083 characters per uri.

phoneNumber

string

Candidate's primary phone number.

additionalPhoneNumbers[]

string

Candidate's other phone numbers.

postalAddresses[]

object (PostalAddress)

List of structured candidate addresses, not validated as actually real addresses.

employmentInfo[]

object (EmploymentInfo)

List of the candidate's experiences.

educationInfo[]

object (EducationInfo)

List of the candidate's education.

source

object (Source)

Candidate's source.

visaAssistanceInfo

object (VisaAssistanceInfo)

Details of a Candidate's need for visa assistance.

startDate

object (Date)

Candidate start date, if hired.

applications[]

string

List of all application resource names that this candidate is and has been considered for. Must follow the format of "tenants/*/applications/*".

EmploymentInfo

EmploymentInfo describes the candidate experience information.

JSON representation
{
  "jobTitle": string,
  "employer": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
jobTitle

string

The title of the role the candidate was employed for.

employer

string

Company or organization name the experience was with.

startDate

object (Date)

Start date of the employment.

Required.

endDate

object (Date)

End date of the employment.

endDate must be after startDate or not provided, otherwise this employment record will considered invalid and will be dropped.

If endDate is not provided, we will consider that it is a current employment record.

EducationInfo

EducationInfo describes the candidate educational information.

JSON representation
{
  "school": string,
  "major": string,
  "degree": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
school

string

School attended.

major

string

The field of study.

degree

string

Educational degree name.

startDate

object (Date)

Start date of the educational program.

endDate

object (Date)

End date of the educational program.

endDate must be after startDate or not provided, otherwise this employment record will considered invalid and will be dropped.

If endDate is not provided, we will consider the educational program ongoing.

Source

Source describes the pipeline from which the candidate originated from.

JSON representation
{
  "type": enum (Type),

  // Union field details can be only one of the following:
  "referringUser": string,
  "label": string
  // End of list of possible types for union field details.
}
Fields
type

enum (Type)

Type of the source.

Union field details. Details about the source. details can be only one of the following:
referringUser

string

User who referred the candidate, if any. It must have the format "tenants/*/users/*"

label

string

A short string used to qualify the source. The value selected for a label is not constrained, but what is considered "typical" is detailed in each source type.

Type

Types of source.

Enums
TYPE_UNSPECIFIED No source specified, details are omitted.
APPLICATION details is a label identifying the conduit of application, for example Craigslist, Indeed, or internal transfer. Hire will set the label to a URL to the specific job board listing if tracking links were configured when the job was posted.
EXTERNAL_REFERRAL details is a label identifying the person or agency that sourced the candidate.
INTERNAL_REFERRAL details is the User who referred the Candidate. Note that referrer will be omitted if the User has been archived or deleted.
SOURCING details is a label identifying the person or agency that sourced the candidate.

VisaAssistanceInfo

VisaAssistanceInfo describes whether the candidate needs legal assistance for employment authorization or immigration.

JSON representation
{
  "needsAssistance": boolean,
  "details": string
}
Fields
needsAssistance

boolean

Candidate has indicated that they may require visa assistance for one or more roles they're being considered for.

details

string

Additional free form details to augment and clarify the needsAssistance field.

Max string length is 25KB.

Methods

get

Get a candidate in Hire.

list

List the candidates in Hire.