List openings

get

https://services.fountain.com/api/servicehire/v2/funnels

Retrieve the openings through which applicants move.

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.

Query Params

active

boolean

Filter by whether the opening is active or not

brand

string

Filter by the name of the brand

created_at_gt

string

Filter for funnels created after this

created_at_lt

string

Filter for funnels created before this

distance

string

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

hiring

boolean

Filter for hiring funnels

hris_ids[]

array of strings

Filter by ATS job IDs stored as opening HRIS IDs

hris_ids[]

is_email_optional

boolean

Email is optional for the opening for applicants

is_visible_to_applicant

boolean

Filter for Candidate AI Agent funnels visible applicant

lat

string

Latitude for distance filtering

listing_status

string

enum

Filter by sourcing status on an account running the four-state sourcing model. Ignored on legacy accounts.

Allowed:

location_address

string

Filter by the address associated with the opening

location_group_name

string

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

location_name

string

Filter by the name of the location associated with the opening

lon

string

Longitude for distance filtering

page

integer

The page of results to view

per_page

integer

The number of results to return per page

pipeline_ratio

integer

Pipeline ratio associated to the opening

query

string

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[]

array of strings

Filter by the days of the shift associated with the opening

shift_days[]

Allowed:

shift_end_time

string

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

shift_name

string

Filter by the name of the shift associated with the opening

shift_start_time

string

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

sort_by

string

enum

The field by which to sort results

Allowed:

sort_direction

string

enum

The direction in which results are sorted

Allowed:

sourcing_purchase_type

string

enum

Filter by the sourcing type of the opening

Allowed:

sourcing

boolean

Filter for sourcing funnels

title

string

Filter by the title of the opening

unfilled

boolean

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_gt

string

Filter for funnels updated after this

updated_at_lt

string

Filter for funnels updated before this

user_openings

boolean

Filter to account owner

workflow_id

string

Filter for funnels with a specific workflow identifier

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401Unauthorized

422The listing_status is not a known sourcing status, or the account has no owner user.