v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

Openings and Stages

List All Openings

List all Opening(s) within your account. Funnel is used interchangeably with Opening. Each Opening contains information on address, stages in the funnel, location, active status, etc. Check the example to see all properties available.

get/v2/funnels

Query parameters

activeboolean

Filter by whether the opening is active or not

brandstring

Filter by the name of the brand

created_at_gtstring

Filter for funnels created after this

created_at_ltstring

Filter for funnels created before this

distancestring

Distance for filtering (e.g., 50mi, 100mi)

hiringboolean

Filter for hiring funnels

is_email_optionalboolean

Email is optional for the opening for applicants

is_visible_to_applicantboolean

Filter for Candidate AI Agent funnels visible applicant

latstring

Latitude for distance filtering

location_addressstring

Filter by the address associated with the opening

location_group_namestring

Filter by the name of the location group associated with the opening

location_namestring

Filter by the name of the location associated with the opening

lonstring

Longitude for distance filtering

pageinteger

The page of results to view

per_pageinteger

The number of results to return per page

pipeline_ratiointeger

Pipeline ratio associated to the opening

querystring

Text-based search for openings. Searches funnel title, location name, location address, brand name, position name, and location group name. This will be slower than other filters.

shift_days[]string[]

Filter by the days of the shift associated with the opening

shift_end_timestring

Filter by the end time of the shift associated with the opening using the 24 hour clock (i.e. 10 PM is 2200)

shift_namestring

Filter by the name of the shift associated with the opening

shift_start_timestring

Filter by the start time of the shift associated with the opening using the 24 hour clock (i.e. 10 PM is 2200)

The field by which to sort results

sort_direction'asc' | 'desc'

The direction in which results are sorted

sourcing_purchase_type'standard' | 'indeed_campaign'

Filter by the sourcing type of the opening

sourcingboolean

Filter for sourcing funnels

titlestring

Filter by the title of the opening

unfilledboolean

Filter openings by hiring goal status. When true, returns only openings that have at least one unfilled hiring goal (not closed) in their current active target group. When false, returns only openings with no such unfilled hiring goals. Omit to return all openings regardless of hiring goal status.

updated_at_gtstring

Filter for funnels updated after this

updated_at_ltstring

Filter for funnels updated before this

user_openingsboolean

Filter to account owner

workflow_idstring

Filter for funnels with a specific workflow identifier

Response

Example response

{
  "funnels": [
    {
      "opening_pay_rate": {
        "compensation": "20.0"
      }
    }
  ]
}