Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Demographic Answer Options

List demographic answer options

Demographic answer options are the selectable choices on a demographic_question. Each option belongs to a single question; multi-select and single-select questions both draw their choices from this resource. Free-text input is modeled as an option with free_form=true, and the I don't wish to answer choice is identified by decline_to_answer=true rather than by matching on name.

get/v3/demographic_answer_options

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

demographic_question_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

activeboolean

Filter by whether the option is still selectable by applicants. Defaults to returning both active and removed options; set true for live options only, false for removed only.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
demographic_question_idinteger

Id of the parent demographic_question this option belongs to. Options are scoped to a single question and never shared across questions.

sort_orderinteger

Display position within the parent question's choice list, ascending. Lower values render first; aliased from the underlying priority column.

activeboolean

true while the option is still selectable by applicants; false after it has been soft-removed. Inactive options are returned by default — pass active=true to filter to live options only. Past demographic_answers continue to reference inactive rows so historical applicant submissions stay readable.

free_formboolean

If true, selecting this option prompts the applicant for a free-text response (e.g. an I prefer to self-describe choice). The free-text content itself is not exposed via Harvest.

namestring nullable

Display label shown to applicants in the answer list (e.g. Non-binary, I prefer to self-describe). null on standard Greenhouse-supplied options whose label is rendered from a localized template rather than this column.

decline_to_answerboolean nullable

true when this option represents a structured I don't wish to answer choice; prefer this flag over matching on name when classifying declines. null on custom-organization options where the flag was never set; treat null as not a decline.