v1

latestOpenAPI 3.1.02026-07-261770816.7 KB

Candidates

Anonymize candidates

Anonymize selected categories of personally identifiable data on a candidate (for GDPR, CCPA, or other right-to-be-forgotten requests). The fields array selects which data groups to scrub — see the schema enum for the full set (e.g. full_name, email_addresses, phone_numbers, attachments, notes, scorecards_and_interviews). Anonymization is irreversible and runs asynchronously when the selected scope is large; the candidate's hiring activity remains intact for reporting.

patch/v3/candidates/{id}/anonymize

Path parameters

idinteger required

Request body

fieldsstring[] required

Response

Successful

idinteger

created_atstring date-time

updated_atstring date-time

first_namestring nullable

last_namestring nullable

preferred_namestring nullable

Preferred or chosen name the candidate goes by, when different from their legal first name.

companystring nullable

Candidate's current company, as entered on their profile.

titlestring nullable

Candidate's current job title, as entered on their profile.

last_activity_atstring date-time nullable

Timestamp of the most recent activity on any of the candidate's applications (notes, emails, stage changes, etc.), in ISO 8601.

privateboolean nullable

If true, the candidate is restricted to users with View Private Candidates access. Defaults to false.

can_emailboolean

Whether this candidate has consented to receive email communication from your organization.

time_zonestring nullable

Candidate's time zone as a Rails-style identifier (for example Eastern Time (US & Canada)).

tagsstring[]

Candidate tag names applied to this candidate within your organization.

linked_user_idsinteger[]

Ids of Greenhouse users linked to this candidate (employees represented by both a user record and a candidate record).

custom_fieldsobject nullable