v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Job Candidate Attributes

List job candidate attributes

Job candidate attributes are the per-job instances of a job's candidate_attribute_types — one row for each evaluable trait (e.g. JavaScript, Leadership) configured on a specific job. This is the canonical list of "what we're rating candidates on" for a given job and is the entry point most AI-matching partners read to score candidate fit. Each row carries the on-job display name, active flag, and sort_order, and points at its parent candidate_attribute_type_id; downstream, focus_candidate_attributes mark which of these are emphasized on a given interview kit and scorecard_candidate_attributes / scorecard_question_candidate_attributes carry the interviewer's ratings against them. Filter by job_ids to scope to one job or by candidate_attribute_type_ids to find every job using a given attribute type. Today this endpoint is site-admin-only.

get/v3/job_candidate_attributes

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

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
job_idsinteger[]

Return only job candidate attributes registered on these job (hiring plan) ids. A job candidate attribute is a scoring rubric item attached to a single job, so this filters to the attributes belonging to those jobs.

candidate_attribute_type_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

activeboolean

When true, return only attributes still in use on the job; when false, only archived ones. Omit to include both.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
job_idinteger

Id of the job this attribute belongs to. Each job has its own set of job_candidate_attributes; there is no org-wide attribute list.

candidate_attribute_type_idinteger

Id of the parent candidate_attribute_type this row is an instance of. The same candidate_attribute_type can appear on many jobs, but each pairing of job and type has at most one job_candidate_attribute.

activeboolean

true when the attribute is in use on the job; false after it has been archived from the job's attribute list. Defaults to true.

sort_orderinteger

Display priority within the job's attribute list. Lower values sort first. null until a user manually reorders the attributes in the Greenhouse UI — newly added attributes have no explicit sort_order.

namestring

Display name of the attribute on this job (e.g. JavaScript, Leadership). Sourced from the parent candidate_attribute_type at creation time and can be edited per job.