Skip to main content
GET
Get one of the company's reasons

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

reason_id
string<uuid>
required

The reason (an id from merchant-reason-list, a decision or a position lifecycle change).

type
enum<string>

Its type, when known (decision or position_status); left out, both are searched.

Available options:
decision,
position_status

Response

The reason.

id
string<uuid>
required

Reason id: reason_id of merchant-reason-save, of a decision and of job-interview-set-state.

type
enum<string>
required

decision: why a candidate was rejected or withdrew. position_status: why a position went on hold, was cancelled, closed or filled.

Available options:
decision,
position_status
label
string
required

The reason as the company wrote it.

sort_order
integer
required

Position in the list (lower first).

status
enum<string>
required

active: offered when deciding or changing a lifecycle. archived: kept on past decisions, no longer offered.

Available options:
active,
archived
kind
enum<string>

Decision reasons: reject (the company turned the candidate down) or withdraw (the candidate pulled out).

Available options:
reject,
withdraw
applies_to
enum<string>[]

Position status reasons: the lifecycles it can be given for.

Available options:
on_hold,
cancelled,
closed,
filled
display_label
string

Decision reasons: the label in the requested language (its translation, else the label).

translations
object

Decision reasons: the label per two-letter language code.

default_key
string

Position status reasons: set on the six defaults while their label is unchanged (budget_freeze, priorities_changed, internal_candidate, role_redefined, filled_outside, other).

use_count
integer

Decision reasons: how many decisions use it.