v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Focus Candidate Attributes

List focus candidate attributes

Focus candidate attributes are the subset of a job's job_candidate_attributes that an individual interview kit elevates as focus areas — the attributes Greenhouse highlights at the top of the interviewer's scorecard so they know which traits to prioritize for that interview. The set is per interview kit, so the same job_candidate_attribute can appear as a focus attribute on multiple kits within the same job. Each row carries only the foreign keys — the attribute's display name and candidate_attribute_type come from the parent job_candidate_attribute. Filter by interview_kit_ids to retrieve a single kit's focus attributes, or by job_candidate_attribute_ids to find every interview kit that focuses on a given attribute. Today this endpoint is site-admin-only.

get/v3/focus_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
interview_kit_idsinteger[]

Return only focus candidate attributes attached to these interview kit ids. An interview kit is a stage's interview definition on a job; look up kits for a job via GET /v3/interview_kits?job_ids=....

job_candidate_attribute_idsinteger[]

Return only focus candidate attributes for these job candidate attribute ids. Job candidate attributes are the scoring rubric items registered on a job (the set of attributes scorecards can score against).

fieldsstring[]

Comma separated list of fields to return

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
interview_kit_idinteger

Id of the interview kit this focus attribute belongs to. Focus attributes are configured per interview kit, so the same job_candidate_attribute may appear as a focus attribute on several kits within the same job.

job_candidate_attribute_idinteger

Id of the job's job_candidate_attribute (the per-job attribute catalogue entry on /v3/job_candidate_attributes) being marked as a focus attribute. The underlying attribute name and candidate_attribute_type live on that record.