Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
Hiring Goals

Create a new hiring goal

Create a new Hiring Goal

post/v2/hiring_goals

Request body

start_datestring required

Start date of the Hiring Goal

hire_bystring

The date that the Hiring Goal ends

goalstring required

The number of hires needed for this Hiring Goal

opening_idstring required

The id of the Opening (also known as Funnel) this Hiring Goal applies to

automatically_close_on_datestring

The date that the Hiring Goal will automatically close

Response

Created

automatically_close_on_datestring nullable

Date that the Hiring Goal will automatically close

closed_atstring datetime

The date and time at which the hiring goal was closed

created_atstring datetime

The date and time at which the hiring goal was created

external_idstring

Unique identifier of the Hiring Goal

funnel_idstring

Unique identifier of the associated opening

goalinteger

Number of hires needed for this Hiring Goal

hire_bystring

Date that the Hiring Goal ends

hires_countinteger

Number of hires currently associated with the Hiring Goal

last_updated_atstring datetime

The date and time at which the hiring goal was last updated

past_dueboolean

Indicates if the hire_by date is in the past

remaining_daysinteger

Number of days until this Hiring Goal ends

stage_idstring

Unique identifier of the associated stage

start_datestring

Date that the Hiring Goal begins

status'unfilled' | 'filled'

Current status of the Hiring Goal