--- updatedAt: 2026-04-27T15:48:57.000Z agentTools: projectIndex: https://harvestdocs.greenhouse.io/llms.txt --- # Create candidate Create a new candidate profile in your organization. `first_name` and `last_name` are required; all other profile fields are optional. Pass a nested `application` object to simultaneously create the candidate's first application — supply a `job_id` to create an applicant, or a `prospect_pool_id` (and omit `job_id`) to create a prospect. Tag names that don't yet exist on the organization are created on the fly. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Harvest API", "version": "v3" }, "servers": [ { "url": "https://harvest.greenhouse.io" } ], "security": [ { "bearer": [] } ], "components": { "securitySchemes": { "bearer": { "description": "JWT access_token from /auth/token. Omit the `sub` claim to act as your integration user, which has organization-wide access. Set `sub` to a Site Admin's user id to act as that user instead — the request is then limited to what that Site Admin can see in Greenhouse, including advanced permissions. Notably, private data such as offers, salary information, private notes, and private fields requires the \"See private notes, private fields, salary info, manage offers, request approval, and approve jobs/offers\" advanced permission; without it, list endpoints for those resources return an empty result and writes are rejected with `403 Forbidden`.", "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "oauth2": { "type": "oauth2", "description": "OAuth2 Authentication", "flows": { "clientCredentials": { "tokenUrl": "https://auth.greenhouse.io/token", "scopes": { "harvest:ai_opt_out_statuses:list": "List ai opt out statuses", "harvest:application_stages:list": "List application stages", "harvest:applications:list": "List applications", "harvest:applications:destroy": "Destroy applications", "harvest:applications:create": "Create applications", "harvest:applications:update": "Update applications", "harvest:applications:hire": "Hire applications", "harvest:applications:convert_to_candidate": "Convert to candidate applications", "harvest:applications:reject": "Reject applications", "harvest:applications:unreject": "Unreject applications", "harvest:applications:move": "Move applications", "harvest:applied_candidate_tags:list": "List applied candidate tags", "harvest:applied_candidate_tags:create": "Create applied candidate tags", "harvest:applied_candidate_tags:destroy": "Destroy applied candidate tags", "harvest:approval_flows:list": "List approval flows", "harvest:approval_flows:create": "Create approval flows", "harvest:approval_flows:update": "Update approval flows", "harvest:approval_flows:request_approvals": "Request approvals", "harvest:approval_flows:replace_approver_groups": "Replace approver groups", "harvest:approver_groups:list": "List approver groups", "harvest:approver_groups:replace_approver": "Replace approvers", "harvest:approvers:list": "List approvers", "harvest:attachments:list": "List attachments", "harvest:attachments:create": "Create attachments", "harvest:attachments:destroy": "Destroy attachments", "harvest:blocked_spam_sources:list": "List blocked spam sources", "harvest:blocked_spam_sources:create": "Create blocked spam sources", "harvest:blocked_spam_sources:destroy": "Destroy blocked spam sources", "harvest:blocked_spam_sources:update": "Update blocked spam sources", "harvest:bulk_requests:list": "List bulk requests", "harvest:candidate_attribute_types:list": "List candidate attribute types", "harvest:candidate_educations:list": "List candidate educations", "harvest:candidate_educations:destroy": "Destroy candidate educations", "harvest:candidate_educations:create": "Create candidate educations", "harvest:candidate_employments:list": "List candidate employments", "harvest:candidate_employments:destroy": "Destroy candidate employments", "harvest:candidate_employments:create": "Create candidate employments", "harvest:candidate_tags:list": "List candidate tags", "harvest:candidate_tags:create": "Create candidate tags", "harvest:candidate_tags:destroy": "Destroy candidate tags", "harvest:candidates:list": "List candidates", "harvest:candidates:create": "Create candidates", "harvest:candidates:destroy": "Destroy candidates", "harvest:candidates:update": "Update candidates", "harvest:candidates:merge": "Merge candidates", "harvest:candidates:anonymize": "Anonymize candidates", "harvest:close_reasons:list": "List close reasons", "harvest:custom_field_departments:list": "List custom field departments", "harvest:custom_field_departments:create": "Create custom field departments", "harvest:custom_field_departments:destroy": "Destroy custom field departments", "harvest:custom_field_offices:list": "List custom field offices", "harvest:custom_field_offices:create": "Create custom field offices", "harvest:custom_field_offices:destroy": "Destroy custom field offices", "harvest:custom_field_options:list": "List custom field options", "harvest:custom_field_options:create": "Create custom field options", "harvest:custom_field_options:destroy": "Destroy custom field options", "harvest:custom_field_options:update": "Update custom field options", "harvest:custom_fields:list": "List custom fields", "harvest:custom_fields:destroy": "Destroy custom fields", "harvest:custom_fields:create": "Create custom fields", "harvest:custom_fields:update": "Update custom fields", "harvest:default_interviewers:list": "List default interviewers", "harvest:demographic_answer_options:list": "List demographic answer options", "harvest:demographic_answers:list": "List demographic answers", "harvest:demographic_question_sets:list": "List demographic question sets", "harvest:demographic_questions:list": "List demographic questions", "harvest:departments:list": "List departments", "harvest:departments:create": "Create departments", "harvest:departments:update": "Update departments", "harvest:eeoc:list": "List eeoc", "harvest:email_templates:list": "List email templates", "harvest:focus_candidate_attributes:list": "List focus candidate attributes", "harvest:future_job_permissions:list": "List future job permissions", "harvest:future_job_permissions:create": "Create future job permissions", "harvest:future_job_permissions:destroy": "Destroy future job permissions", "harvest:interview_kits:list": "List interview kits", "harvest:interview_media:list": "List interview media", "harvest:interviewer_tags:list": "List interviewer tags", "harvest:interviewers:list": "List interviewers", "harvest:interviews:list": "List interviews", "harvest:interviews:create": "Create interviews", "harvest:interviews:destroy": "Destroy interviews", "harvest:interviews:update": "Update interviews", "harvest:job_board_custom_locations:list": "List job board custom locations", "harvest:job_boards:list": "List job boards", "harvest:job_candidate_attributes:list": "List job candidate attributes", "harvest:job_hiring_managers:list": "List job hiring managers", "harvest:job_hiring_managers:create": "Create job hiring managers", "harvest:job_hiring_managers:destroy": "Destroy job hiring managers", "harvest:job_interview_stages:list": "List job interview stages", "harvest:job_interviews:list": "List job interviews", "harvest:job_notes:list": "List job notes", "harvest:job_notes:create": "Create job notes", "harvest:job_notes:destroy": "Destroy job notes", "harvest:job_notes:update": "Update job notes", "harvest:job_owners:list": "List job owners", "harvest:job_owners:create": "Create job owners", "harvest:job_owners:destroy": "Destroy job owners", "harvest:job_post_locations:list": "List job post locations", "harvest:job_post_locations:create": "Create job post locations", "harvest:job_post_locations:destroy": "Destroy job post locations", "harvest:job_posts:list": "List job posts", "harvest:job_posts:create": "Create job posts", "harvest:job_posts:update": "Update job posts", "harvest:jobs:list": "List jobs", "harvest:jobs:create": "Create jobs", "harvest:jobs:update": "Update jobs", "harvest:notes:list": "List notes", "harvest:notes:create": "Create notes", "harvest:offers:list": "List offers", "harvest:offers:create": "Create offers", "harvest:offers:update": "Update offers", "harvest:offices:list": "List offices", "harvest:offices:create": "Create offices", "harvest:offices:update": "Update offices", "harvest:openings:list": "List openings", "harvest:openings:create": "Create openings", "harvest:openings:destroy": "Destroy openings", "harvest:openings:update": "Update openings", "harvest:pay_input_ranges:list": "List pay input ranges", "harvest:pay_inputs:list": "List pay inputs", "harvest:prospect_details:list": "List prospect details", "harvest:prospect_pool_stages:list": "List prospect pool stages", "harvest:prospect_pools:list": "List prospect pools", "harvest:referrers:list": "List referrers", "harvest:rejection_details:list": "List rejection details", "harvest:rejection_details:update": "Update rejection details", "harvest:rejection_reasons:list": "List rejection reasons", "harvest:rejection_reasons:show": "Show rejection reasons", "harvest:scorecard_candidate_attributes:list": "List scorecard candidate attributes", "harvest:scorecard_candidate_attributes:create": "Create scorecard candidate attributes", "harvest:scorecard_candidate_attributes:update": "Update scorecard candidate attributes", "harvest:scorecard_question_answer_options:create": "Create scorecard question answer options", "harvest:scorecard_question_answer_options:list": "List scorecard question answer options", "harvest:scorecard_question_answers:list": "List scorecard question answers", "harvest:scorecard_question_answers:create": "Create scorecard question answers", "harvest:scorecard_question_answers:update": "Update scorecard question answers", "harvest:scorecard_question_candidate_attributes:list": "List scorecard question candidate attributes", "harvest:scorecard_question_options:list": "List scorecard question options", "harvest:scorecard_questions:list": "List scorecard questions", "harvest:scorecards:list": "List scorecards", "harvest:scorecards:create": "Create scorecards", "harvest:scorecards:update": "Update scorecards", "harvest:job_post_searchable_locations:list": "List job post searchable locations", "harvest:sources:list": "List sources", "harvest:tracking_links:list": "List tracking links", "harvest:user_emails:list": "List user emails", "harvest:user_emails:create": "Create user emails", "harvest:user_job_permissions:list": "List user job permissions", "harvest:user_job_permissions:create": "Create user job permissions", "harvest:user_job_permissions:destroy": "Destroy user job permissions", "harvest:user_roles:list": "List user roles", "harvest:users:list": "List users", "harvest:users:create": "Create users", "harvest:users:update": "Update users", "harvest:users:deactivate": "Deactivate users", "harvest:users:activate": "Activate users", "harvest:users:revoke_permissions": "Revoke permissions users", "harvest:webhooks:create": "Create webhooks", "harvest:webhooks:update": "Update webhooks", "harvest:webhooks:destroy": "Destroy webhooks", "harvest:webhooks:list": "List webhooks", "auditlog:events:list": "List audit log events" } }, "authorizationCode": { "authorizationUrl": "https://auth.greenhouse.io/authorize", "tokenUrl": "https://auth.greenhouse.io/token", "refreshUrl": "https://auth.greenhouse.io/token", "scopes": { "harvest:ai_opt_out_statuses:list": "List ai opt out statuses", "harvest:application_stages:list": "List application stages", "harvest:applications:list": "List applications", "harvest:applications:destroy": "Destroy applications", "harvest:applications:create": "Create applications", "harvest:applications:update": "Update applications", "harvest:applications:hire": "Hire applications", "harvest:applications:convert_to_candidate": "Convert to candidate applications", "harvest:applications:reject": "Reject applications", "harvest:applications:unreject": "Unreject applications", "harvest:applications:move": "Move applications", "harvest:applied_candidate_tags:list": "List applied candidate tags", "harvest:applied_candidate_tags:create": "Create applied candidate tags", "harvest:applied_candidate_tags:destroy": "Destroy applied candidate tags", "harvest:approval_flows:list": "List approval flows", "harvest:approval_flows:create": "Create approval flows", "harvest:approval_flows:update": "Update approval flows", "harvest:approval_flows:request_approvals": "Request approvals", "harvest:approval_flows:replace_approver_groups": "Replace approver groups", "harvest:approver_groups:list": "List approver groups", "harvest:approver_groups:replace_approver": "Replace approvers", "harvest:approvers:list": "List approvers", "harvest:attachments:list": "List attachments", "harvest:attachments:create": "Create attachments", "harvest:attachments:destroy": "Destroy attachments", "harvest:blocked_spam_sources:list": "List blocked spam sources", "harvest:blocked_spam_sources:create": "Create blocked spam sources", "harvest:blocked_spam_sources:destroy": "Destroy blocked spam sources", "harvest:blocked_spam_sources:update": "Update blocked spam sources", "harvest:bulk_requests:list": "List bulk requests", "harvest:candidate_attribute_types:list": "List candidate attribute types", "harvest:candidate_educations:list": "List candidate educations", "harvest:candidate_educations:destroy": "Destroy candidate educations", "harvest:candidate_educations:create": "Create candidate educations", "harvest:candidate_employments:list": "List candidate employments", "harvest:candidate_employments:destroy": "Destroy candidate employments", "harvest:candidate_employments:create": "Create candidate employments", "harvest:candidate_tags:list": "List candidate tags", "harvest:candidate_tags:create": "Create candidate tags", "harvest:candidate_tags:destroy": "Destroy candidate tags", "harvest:candidates:list": "List candidates", "harvest:candidates:create": "Create candidates", "harvest:candidates:destroy": "Destroy candidates", "harvest:candidates:update": "Update candidates", "harvest:candidates:merge": "Merge candidates", "harvest:candidates:anonymize": "Anonymize candidates", "harvest:close_reasons:list": "List close reasons", "harvest:custom_field_departments:list": "List custom field departments", "harvest:custom_field_departments:create": "Create custom field departments", "harvest:custom_field_departments:destroy": "Destroy custom field departments", "harvest:custom_field_offices:list": "List custom field offices", "harvest:custom_field_offices:create": "Create custom field offices", "harvest:custom_field_offices:destroy": "Destroy custom field offices", "harvest:custom_field_options:list": "List custom field options", "harvest:custom_field_options:create": "Create custom field options", "harvest:custom_field_options:destroy": "Destroy custom field options", "harvest:custom_field_options:update": "Update custom field options", "harvest:custom_fields:list": "List custom fields", "harvest:custom_fields:destroy": "Destroy custom fields", "harvest:custom_fields:create": "Create custom fields", "harvest:custom_fields:update": "Update custom fields", "harvest:default_interviewers:list": "List default interviewers", "harvest:demographic_answer_options:list": "List demographic answer options", "harvest:demographic_answers:list": "List demographic answers", "harvest:demographic_question_sets:list": "List demographic question sets", "harvest:demographic_questions:list": "List demographic questions", "harvest:departments:list": "List departments", "harvest:departments:create": "Create departments", "harvest:departments:update": "Update departments", "harvest:eeoc:list": "List eeoc", "harvest:email_templates:list": "List email templates", "harvest:focus_candidate_attributes:list": "List focus candidate attributes", "harvest:future_job_permissions:list": "List future job permissions", "harvest:future_job_permissions:create": "Create future job permissions", "harvest:future_job_permissions:destroy": "Destroy future job permissions", "harvest:interview_kits:list": "List interview kits", "harvest:interview_media:list": "List interview media", "harvest:interviewer_tags:list": "List interviewer tags", "harvest:interviewers:list": "List interviewers", "harvest:interviews:list": "List interviews", "harvest:interviews:create": "Create interviews", "harvest:interviews:destroy": "Destroy interviews", "harvest:interviews:update": "Update interviews", "harvest:job_board_custom_locations:list": "List job board custom locations", "harvest:job_boards:list": "List job boards", "harvest:job_candidate_attributes:list": "List job candidate attributes", "harvest:job_hiring_managers:list": "List job hiring managers", "harvest:job_hiring_managers:create": "Create job hiring managers", "harvest:job_hiring_managers:destroy": "Destroy job hiring managers", "harvest:job_interview_stages:list": "List job interview stages", "harvest:job_interviews:list": "List job interviews", "harvest:job_notes:list": "List job notes", "harvest:job_notes:create": "Create job notes", "harvest:job_notes:destroy": "Destroy job notes", "harvest:job_notes:update": "Update job notes", "harvest:job_owners:list": "List job owners", "harvest:job_owners:create": "Create job owners", "harvest:job_owners:destroy": "Destroy job owners", "harvest:job_post_locations:list": "List job post locations", "harvest:job_post_locations:create": "Create job post locations", "harvest:job_post_locations:destroy": "Destroy job post locations", "harvest:job_posts:list": "List job posts", "harvest:job_posts:create": "Create job posts", "harvest:job_posts:update": "Update job posts", "harvest:jobs:list": "List jobs", "harvest:jobs:create": "Create jobs", "harvest:jobs:update": "Update jobs", "harvest:notes:list": "List notes", "harvest:notes:create": "Create notes", "harvest:offers:list": "List offers", "harvest:offers:create": "Create offers", "harvest:offers:update": "Update offers", "harvest:offices:list": "List offices", "harvest:offices:create": "Create offices", "harvest:offices:update": "Update offices", "harvest:openings:list": "List openings", "harvest:openings:create": "Create openings", "harvest:openings:destroy": "Destroy openings", "harvest:openings:update": "Update openings", "harvest:pay_input_ranges:list": "List pay input ranges", "harvest:pay_inputs:list": "List pay inputs", "harvest:prospect_details:list": "List prospect details", "harvest:prospect_pool_stages:list": "List prospect pool stages", "harvest:prospect_pools:list": "List prospect pools", "harvest:referrers:list": "List referrers", "harvest:rejection_details:list": "List rejection details", "harvest:rejection_details:update": "Update rejection details", "harvest:rejection_reasons:list": "List rejection reasons", "harvest:rejection_reasons:show": "Show rejection reasons", "harvest:scorecard_candidate_attributes:list": "List scorecard candidate attributes", "harvest:scorecard_candidate_attributes:create": "Create scorecard candidate attributes", "harvest:scorecard_candidate_attributes:update": "Update scorecard candidate attributes", "harvest:scorecard_question_answer_options:create": "Create scorecard question answer options", "harvest:scorecard_question_answer_options:list": "List scorecard question answer options", "harvest:scorecard_question_answers:list": "List scorecard question answers", "harvest:scorecard_question_answers:create": "Create scorecard question answers", "harvest:scorecard_question_answers:update": "Update scorecard question answers", "harvest:scorecard_question_candidate_attributes:list": "List scorecard question candidate attributes", "harvest:scorecard_question_options:list": "List scorecard question options", "harvest:scorecard_questions:list": "List scorecard questions", "harvest:scorecards:list": "List scorecards", "harvest:scorecards:create": "Create scorecards", "harvest:scorecards:update": "Update scorecards", "harvest:job_post_searchable_locations:list": "List job post searchable locations", "harvest:sources:list": "List sources", "harvest:tracking_links:list": "List tracking links", "harvest:user_emails:list": "List user emails", "harvest:user_emails:create": "Create user emails", "harvest:user_job_permissions:list": "List user job permissions", "harvest:user_job_permissions:create": "Create user job permissions", "harvest:user_job_permissions:destroy": "Destroy user job permissions", "harvest:user_roles:list": "List user roles", "harvest:users:list": "List users", "harvest:users:create": "Create users", "harvest:users:update": "Update users", "harvest:users:deactivate": "Deactivate users", "harvest:users:activate": "Activate users", "harvest:users:revoke_permissions": "Revoke permissions users", "harvest:webhooks:create": "Create webhooks", "harvest:webhooks:update": "Update webhooks", "harvest:webhooks:destroy": "Destroy webhooks", "harvest:webhooks:list": "List webhooks", "auditlog:events:list": "List audit log events" } } } } } }, "paths": { "/v3/candidates": { "post": { "summary": "Create candidate", "description": "Create a new candidate profile in your organization. `first_name` and `last_name` are required; all other profile fields are optional. Pass a nested `application` object to simultaneously create the candidate's first application — supply a `job_id` to create an applicant, or a `prospect_pool_id` (and omit `job_id`) to create a prospect. Tag names that don't yet exist on the organization are created on the fly.", "tags": [ "Candidates" ], "security": [ { "oauth2": [ "harvest:candidates:create" ] }, { "bearer": [] } ], "parameters": [], "responses": { "201": { "description": "Successful", "content": { "application/json": { "examples": { "example_response": { "value": { "candidate": { "id": 1, "first_name": "John", "last_name": "Doe", "preferred_name": null, "company": null, "title": null, "created_at": "2024-01-01T00:00:00.000Z", "updated_at": "2024-01-01T00:00:00.000Z", "can_email": true, "time_zone": null, "last_activity_at": "2024-01-01T00:00:00.000Z", "private": false, "tags": [], "linked_user_ids": [], "phone_numbers": [], "addresses": [], "email_addresses": [], "website_addresses": [], "social_media_addresses": [], "custom_fields": {} }, "application": { "id": 2, "referrer_id": null, "source_id": null, "agency_note_id": null, "recruiter_id": null, "coordinator_id": null, "needs_decision": null, "prospect": true, "rejected_at": null, "created_at": "2024-01-01T00:00:00.000Z", "updated_at": "2024-01-01T00:00:00.000Z", "last_activity_at": "2024-01-01T00:00:00.000Z", "stage_id": null, "job_interview_stage_id": null, "candidate_id": 1, "rejection_reason_id": null, "job_id": null, "job_post_id": null, "status": "in_process", "stage_name": null, "custom_fields": {}, "location_address": null, "answers": [], "prospective_job_ids": [] } } } }, "schema": { "type": "object", "properties": { "candidate": {}, "application": {} } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Unprocessable Content" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name" ], "properties": { "first_name": { "type": "string", "maxLength": 255 }, "last_name": { "type": "string", "maxLength": 255 }, "preferred_name": { "type": "string", "maxLength": 255 }, "time_zone": { "type": "string", "enum": [ "international date line west", "midway island", "american samoa", "hawaii", "alaska", "pacific time (us & canada)", "tijuana", "mountain time (us & canada)", "arizona", "chihuahua", "mazatlan", "central time (us & canada)", "saskatchewan", "guadalajara", "mexico city", "monterrey", "central america", "eastern time (us & canada)", "indiana (east)", "bogota", "lima", "quito", "atlantic time (canada)", "caracas", "la paz", "santiago", "asuncion", "newfoundland", "brasilia", "buenos aires", "montevideo", "georgetown", "puerto rico", "greenland", "mid-atlantic", "azores", "cape verde is.", "dublin", "edinburgh", "lisbon", "london", "casablanca", "monrovia", "utc", "belgrade", "bratislava", "budapest", "ljubljana", "prague", "sarajevo", "skopje", "warsaw", "zagreb", "brussels", "copenhagen", "madrid", "paris", "amsterdam", "berlin", "bern", "zurich", "rome", "stockholm", "vienna", "west central africa", "bucharest", "cairo", "helsinki", "kyiv", "riga", "sofia", "tallinn", "vilnius", "athens", "istanbul", "minsk", "jerusalem", "harare", "pretoria", "kaliningrad", "moscow", "st. petersburg", "volgograd", "samara", "kuwait", "riyadh", "nairobi", "baghdad", "tehran", "abu dhabi", "muscat", "baku", "tbilisi", "yerevan", "kabul", "ekaterinburg", "islamabad", "karachi", "tashkent", "chennai", "kolkata", "mumbai", "new delhi", "kathmandu", "dhaka", "sri jayawardenepura", "almaty", "astana", "novosibirsk", "rangoon", "bangkok", "hanoi", "jakarta", "krasnoyarsk", "beijing", "chongqing", "hong kong", "urumqi", "kuala lumpur", "singapore", "taipei", "perth", "irkutsk", "ulaanbaatar", "seoul", "osaka", "sapporo", "tokyo", "yakutsk", "darwin", "adelaide", "canberra", "melbourne", "sydney", "brisbane", "hobart", "vladivostok", "guam", "port moresby", "magadan", "srednekolymsk", "solomon is.", "new caledonia", "fiji", "kamchatka", "marshall is.", "auckland", "wellington", "nuku'alofa", "tokelau is.", "chatham is.", "samoa" ] }, "company": { "type": "string" }, "title": { "type": "string", "maxLength": 255 }, "can_email": { "type": "boolean" }, "phone_numbers": { "type": "array", "items": { "type": "object", "required": [ "value", "type" ], "properties": { "value": { "type": "string" }, "type": { "type": "string", "enum": [ "home", "work", "mobile", "skype", "other" ] } } } }, "addresses": { "type": "array", "items": { "type": "object", "required": [ "value", "type" ], "properties": { "value": { "type": "string" }, "type": { "type": "string", "enum": [ "home", "work", "other" ] } } } }, "email_addresses": { "type": "array", "items": { "type": "object", "required": [ "value", "type" ], "properties": { "value": { "type": "string" }, "type": { "type": "string", "enum": [ "personal", "work", "other" ] } } } }, "website_addresses": { "type": "array", "items": { "type": "object", "required": [ "value", "type" ], "properties": { "value": { "type": "string" }, "type": { "type": "string", "enum": [ "personal", "company", "portfolio", "blog", "other" ] } } } }, "social_media_addresses": { "type": "array", "items": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string" } } } }, "tags": { "type": "array", "items": { "type": "string" } }, "linked_user_ids": { "type": "array", "items": { "type": "integer" } }, "custom_fields": { "type": "array", "items": { "type": "object", "additionalProperties": false, "oneOf": [ { "title": "By Name Key", "required": [ "name_key" ] }, { "title": "By Custom Field ID", "required": [ "custom_field_id" ] } ], "properties": { "name_key": { "type": "string", "maxLength": 255, "description": "Required if custom_field_id is not provided. Exactly one of name_key or custom_field_id must be specified." }, "custom_field_id": { "type": "integer", "description": "Required if name_key is not provided. Exactly one of name_key or custom_field_id must be specified." }, "value": { "anyOf": [ { "type": "string", "title": "Short Text" }, { "type": "string", "title": "Long Text" }, { "type": "string", "title": "Rich Text" }, { "type": "string", "title": "URL" }, { "type": "string", "title": "Date" }, { "type": "boolean", "title": "Yes/No" }, { "type": "number", "title": "User", "description": "User ID" }, { "title": "Single Select", "description": "Option name (string) or option ID (number).", "type": [ "number", "string" ] }, { "type": "array", "title": "Multi-select", "description": "Array of option names (strings) or option IDs (numbers).", "oneOf": [ { "title": "Option Names", "items": { "type": "string" } }, { "title": "Option IDs", "items": { "type": "number" } } ] }, { "type": "number", "title": "Number" }, { "type": "object", "title": "Currency", "required": [ "amount", "currency_code" ], "properties": { "amount": { "type": "number" }, "currency_code": { "type": "string", "maxLength": 3 } }, "additionalProperties": false }, { "type": "object", "title": "Currency Range", "required": [ "min_amount", "max_amount", "currency_code" ], "properties": { "min_amount": { "type": "number" }, "max_amount": { "type": "number" }, "currency_code": { "type": "string", "maxLength": 3 } }, "additionalProperties": false }, { "type": "object", "title": "Number Range", "required": [ "min_value", "max_value" ], "properties": { "min_value": { "type": "number" }, "max_value": { "type": "number" } }, "additionalProperties": false }, { "type": "null", "title": "Clear", "description": "Pass null to clear the field's value." } ] } } } }, "application": { "type": "object", "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "job_id" ], "properties": { "source_id": { "type": "integer" }, "recruiter_id": { "type": "integer" }, "coordinator_id": { "type": "integer" }, "referrer_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "custom_fields": { "type": "array", "items": { "type": "object", "additionalProperties": false, "oneOf": [ { "title": "By Name Key", "required": [ "name_key" ] }, { "title": "By Custom Field ID", "required": [ "custom_field_id" ] } ], "properties": { "name_key": { "type": "string", "maxLength": 255, "description": "Required if custom_field_id is not provided. Exactly one of name_key or custom_field_id must be specified." }, "custom_field_id": { "type": "integer", "description": "Required if name_key is not provided. Exactly one of name_key or custom_field_id must be specified." }, "value": { "anyOf": [ { "type": "string", "title": "Short Text" }, { "type": "string", "title": "Long Text" }, { "type": "string", "title": "URL" }, { "type": "string", "title": "Date" }, { "type": "boolean", "title": "Yes/No" }, { "type": "number", "title": "User", "description": "User ID" }, { "title": "Single Select", "description": "Option name (string) or option ID (number).", "type": [ "number", "string" ] }, { "type": "array", "title": "Multi-select", "description": "Array of option names (strings) or option IDs (numbers).", "oneOf": [ { "title": "Option Names", "items": { "type": "string" } }, { "title": "Option IDs", "items": { "type": "number" } } ] }, { "type": "number", "title": "Number" }, { "type": "object", "title": "Currency", "required": [ "amount", "currency_code" ], "properties": { "amount": { "type": "number" }, "currency_code": { "type": "string", "maxLength": 3 } }, "additionalProperties": false }, { "type": "null", "title": "Clear", "description": "Pass null to clear the field's value." } ] } } } }, "job_id": { "type": "integer" }, "initial_stage_id": { "type": "integer" } } }, { "type": "object", "additionalProperties": false, "required": [ "prospect" ], "properties": { "source_id": { "type": "integer" }, "recruiter_id": { "type": "integer" }, "coordinator_id": { "type": "integer" }, "referrer_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "custom_fields": { "type": "array", "items": { "type": "object", "additionalProperties": false, "oneOf": [ { "title": "By Name Key", "required": [ "name_key" ] }, { "title": "By Custom Field ID", "required": [ "custom_field_id" ] } ], "properties": { "name_key": { "type": "string", "maxLength": 255, "description": "Required if custom_field_id is not provided. Exactly one of name_key or custom_field_id must be specified." }, "custom_field_id": { "type": "integer", "description": "Required if name_key is not provided. Exactly one of name_key or custom_field_id must be specified." }, "value": { "anyOf": [ { "type": "string", "title": "Short Text" }, { "type": "string", "title": "Long Text" }, { "type": "string", "title": "URL" }, { "type": "string", "title": "Date" }, { "type": "boolean", "title": "Yes/No" }, { "type": "number", "title": "User", "description": "User ID" }, { "title": "Single Select", "description": "Option name (string) or option ID (number).", "type": [ "number", "string" ] }, { "type": "array", "title": "Multi-select", "description": "Array of option names (strings) or option IDs (numbers).", "oneOf": [ { "title": "Option Names", "items": { "type": "string" } }, { "title": "Option IDs", "items": { "type": "number" } } ] }, { "type": "number", "title": "Number" }, { "type": "object", "title": "Currency", "required": [ "amount", "currency_code" ], "properties": { "amount": { "type": "number" }, "currency_code": { "type": "string", "maxLength": 3 } }, "additionalProperties": false }, { "type": "null", "title": "Clear", "description": "Pass null to clear the field's value." } ] } } } }, "prospect": { "type": "boolean" }, "job_ids": { "type": "array", "items": { "type": "integer" } }, "prospect_pool_id": { "type": "integer" }, "prospect_pool_stage_id": { "type": "integer" }, "prospect_owner_id": { "type": "integer" }, "prospective_department_id": { "type": "integer" }, "prospective_office_id": { "type": "integer" } } } ] } } } } } } } } } } ```