List movement (shortlist & reject) reasons

Returns the company's configured Shortlist Reasons and Reject Reasons — the values recruiters can pick when moving a candidate to a shortlisted or rejected state. Soft-deleted reasons are excluded.

Filtering: Use the optional type query parameter to narrow the results to a single bucket (rejected or shortlisted). Omitting it returns both buckets in one response. Any other value returns 422 Unprocessable Entity.

Pagination: Use page and per_page (default 25, max 100). The response headers X-Total-Count (total matching reasons) and X-Page-Count (total pages) make page traversal straightforward.

Query Params
string
required

The API key provided for your application.

string
enum

Optional filter restricting the response to a single bucket. Allowed values are rejected (Reject Reasons only) or shortlisted (Shortlist Reasons only). Any other value returns 422.

Allowed:
integer
≥ 1
Defaults to 1

Page number (1-based). Defaults to 1.

integer
1 to 100
Defaults to 25

Page size. Defaults to 25, capped at 100.

Responses

401

Missing, invalid, or inactive API key.

500

Internal server error; the response may include an exception message.

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