Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
Openings and Stages

Create a new opening

Create a new Opening

post/v2/funnels

Request body

activeboolean nullable

Indicator for whether the opening is active

additional_infostring nullable

Additional info about the opening

alternative_localesstring[] nullable

List of alternate locales

clone_workflow_idstring nullable

The unique identifier for a workflow to clone and then associate the clone to the opening

compensation_currency_codestring nullable

The currency of the pay rate

compensation_type'hour' | 'day' | 'month' | 'year' nullable

How often the pay occurs

compensationstring nullable

The pay rate

custom_idstring nullable

Identifier custom to opening for the account

do_launch_portal_from_formboolean nullable

Indicator for whether to launch the applicant into the workflow after application

external_titlestring nullable

Title that will be show on sourcing and career sites

force_applicant_identityboolean nullable

Indicator for whether applicant identity is enforced

is_hiring_funnelboolean nullable

Indicator for whether the opening is for hiring

is_privateboolean nullable

Indicator for whether the opening is private

is_sourcing_funnelboolean nullable

Indicator for whether the opening is for sourcing

job_hours'full_time' | 'part_time' nullable

Indicator for whether the opening is full or part time

job_industry'accounting' | 'agriculture' | 'audio_visual' | 'automotive' | 'banking_and_finance' | 'business_operations' | 'construction' | 'consultancy' | 'customer_service_and_call_centres' | 'dental' | 'education_and_training' | 'electronics' | 'energy_oil_and_gas' | 'engineering' | 'environmental_and_waste' | 'facilities_management' | 'food_hospitality' | 'franchise_services' | 'hair_beauty_and_cosmetics' | 'health_medical_and_related' | 'human_resources' | 'insurance' | 'it_and_internet' | 'legal' | 'logistics_procurement_distribution_and_supply_chain' | 'management_executive' | 'manufacturing_and_production' | 'marketing_advertising_and_pr' | 'media_new_media_and_creative' | 'military_and_defence' | 'mining' | 'nonprofit' | 'other' | 'property_and_real-estate' | 'recruitment' | 'retail' | 'sales' | 'scientific_and_pharmaceuticals' | 'secretarial_and_administration' | 'telecommunications' | 'training' | 'travel_leisure_and_tourism' | 'transportation' | 'web_html_info_design' | 'writing_editing' nullable

Industry the opening is for

job_type'permanent' | 'temporary' | 'contract_freelancer' | 'casual' | 'finance_plus_accounting' | 'operations_leadership' | 'all_other_administrative_plus_professional' | 'information_technology' | 'customer_service_plus_operations' | 'local' | 'regional' | 'trainee' | 'shuttle' nullable

The type of job represented by the opening

location_idstring required

The unique identifier for the location associated to the opening

owner_idstring nullable

The unique identifier for the owner to be associated to the opening

position_idstring required

The unique identifier for the position associated to the opening

shift_idstring nullable

The unique identifier for the shift to be associated to the opening

titlestring required

The title of the opening

use_obiq_formboolean nullable

Indicator for whether an external application form will be used

use_workflowboolean nullable

Indicator for whether to create a new workflow based on the opening

workflow_idstring nullable

The unique identifier for the workflow to associate to the opening

Response

Created

activeboolean required

Indicator for whether the opening is active

go_enabledboolean nullable

When true, indicates this opening is enabled for Hire Go and visible in Hire Go.

additional_infostring nullable

Additional info about the opening

addressstring required

The address of the opening

alternative_localesstring[]

List of alternate locales

apply_urlstring required

The URL with which to apply to the opening

brandstring nullable

The brand the opening is associated with

created_atstring required

Date when the opening was created

custom_idstring nullable

Identifier custom to opening for the account

descriptionstring

The description of the opening

external_titlestring nullable

Title that will be show on sourcing and career sites

force_applicant_identityboolean nullable

Indicator for whether applicant identity is enforced

idstring required

Unique identifier for the opening

is_email_optionalboolean

Indicator for whether email is optional for the opening applicants

is_hiring_funnelboolean required

Indicator for whether the opening is for hiring

is_internal_funnelboolean required

Indicates whether the opening is an internal job posting

is_privateboolean required

Indicator for whether the opening is private

is_sourcing_funnelboolean required

Indicator for whether the opening is for sourcing

is_visible_to_applicantboolean

Indicator for whether the opening is visible for Candidate AI Agent

job_hours'full_time' | 'part_time' nullable

Indicator for whether the opening is full or part time

job_industry'accounting' | 'agriculture' | 'audio_visual' | 'automotive' | 'banking_and_finance' | 'business_operations' | 'construction' | 'consultancy' | 'customer_service_and_call_centres' | 'dental' | 'education_and_training' | 'electronics' | 'energy_oil_and_gas' | 'engineering' | 'environmental_and_waste' | 'facilities_management' | 'food_hospitality' | 'franchise_services' | 'hair_beauty_and_cosmetics' | 'health_medical_and_related' | 'human_resources' | 'insurance' | 'it_and_internet' | 'legal' | 'logistics_procurement_distribution_and_supply_chain' | 'management_executive' | 'manufacturing_and_production' | 'marketing_advertising_and_pr' | 'media_new_media_and_creative' | 'military_and_defence' | 'mining' | 'nonprofit' | 'other' | 'property_and_real-estate' | 'recruitment' | 'retail' | 'sales' | 'scientific_and_pharmaceuticals' | 'secretarial_and_administration' | 'telecommunications' | 'training' | 'travel_leisure_and_tourism' | 'transportation' | 'web_html_info_design' | 'writing_editing' nullable

Industry the opening is for

job_type'permanent' | 'temporary' | 'contract_freelancer' | 'casual' | 'finance_plus_accounting' | 'operations_leadership' | 'all_other_administrative_plus_professional' | 'information_technology' | 'customer_service_plus_operations' | 'local' | 'regional' | 'trainee' | 'shuttle' nullable

The type of job represented by the opening

pay_transparency_requiredboolean

Indicator for whether pay transparency is legally required for this opening's location

pipeline_ratiointeger nullable

Pipeline ratio associated to the opening

requirementsstring

Description of what is required for the opening

time_zonestring required

The timezone of the opening

titlestring

The title of the opening

workflow_idstring nullable

Unique identifier with the workflow associated to the opening

Example response

{
  "opening_pay_rate": {
    "compensation": "20.0"
  }
}