API Reference
Log In
API Reference

List Hiring Goals

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Filter by a particular Opening (also known as Funnel)

string

Filter by a specific Hiring Goal ID

integer

The page of results to view

integer

The number of results to return per page

string

The field by which to sort results

string
enum

The direction in which results are sorted

Allowed:
string
enum

Filter by the Hiring Goal status

Allowed:
boolean

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

boolean

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

boolean

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

string

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

string

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

string

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

string

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

string

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

string

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json