v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
Hiring Goals

List Hiring Goals

List all Hiring Goals within your account. Check the example to see all properties available.

get/v2/hiring_goals

Query parameters

opening_idinteger

Filter by a particular Opening (also known as Funnel)

hiring_goal_idstring

Filter by a specific Hiring Goal ID

pageinteger

The page of results to view

per_pageinteger

The number of results to return per page

sort_bystring

The field by which to sort results

sort_direction'asc' | 'desc'

The direction in which results are sorted

status'unfilled' | 'filled'

Filter by the Hiring Goal status

currentboolean

Filter to current Hiring Goals. Current is defined by Hiring Goals with a hire_by date greater and or equal to today.

pastboolean

Filter to past Hiring Goals. Current is defined by Hiring Goals with a hire_by date before today.

openboolean

Filter to open Hiring Goals. Open Hiring Goals are Hiring Goals who have not been closed (closed_at == nil)

created_at_gtstring

Filter to Hiring Goals created after this date (ISO 8601 format)

created_at_ltstring

Filter to Hiring Goals created before this date (ISO 8601 format)

updated_at_gtstring

Filter to Hiring Goals updated after this date (ISO 8601 format)

updated_at_ltstring

Filter to Hiring Goals updated before this date (ISO 8601 format)

hire_by_gtstring

Filter to Hiring Goals with hire_by date after this date (ISO 8601 format)

hire_by_ltstring

Filter to Hiring Goals with hire_by date before this date (ISO 8601 format)

Response

OK