Operations (sample payloads)
Main operations
Create candidate
Create a new candidate Sample Input Sample Output
Create candidate application
Create a new application for this candidate or prospect. If a prospect, this will add a new candidate application to the given job on their profile, this will not convert their existing prospect application into a candidate application. Sample Input Sample Output
{
"credited_to": \{
"id": null,
"name": "Jane Smith",
"employee_id": null
\},
"prospect_detail": \{
"prospect_pool": null,
"prospect_stage": null,
"prospect_owner": null
\},
"rejection_details": null,
"prospect": false,
"status": "active",
"rejected_at": null,
"answers": [],
"applied_at": "2023-05-15T14:30:00Z",
"location": null,
"jobs": [
\{
"id": 54321,
"name": "Software Engineer"
\}
],
"candidate_id": 67890,
"current_stage": \{
"id": 1234,
"name": "Application Review"
\},
"rejection_reason": null,
"last_activity_at": "2023-05-15T14:30:00Z",
"source": \{
"id": 9876,
"public_name": "Employee Referral"
\},
"id": 98765
}
Create candidate note
Create a candidate note. Sample Input Sample Output
Create prospect
Create a new prospect. The difference between a prospect and a candidate is that a prospect can be on no jobs or many jobs. Sample Input
{
"user_id": 12345,
"title": "Software Engineer",
"first_name": "John",
"last_name": "Doe",
"company": "Tech Solutions Inc.",
"phone_numbers": [
\{
"type2": "mobile",
"value": "+1 (555) 123-4567"
\}
],
"addresses": [
\{
"type2": "work",
"value": "123 Tech Street, San Francisco, CA 94105"
\}
],
"email_addresses": [
\{
"type2": "work",
"value": "john.doe@techsolutions.com"
\}
],
"website_addresses": [
\{
"type2": "portfolio",
"value": "https://johndoe.portfolio.com"
\}
],
"social_media_addresses": [
"https://linkedin.com/in/johndoe"
],
"tags": [
"Java",
"Python",
"Cloud Computing"
],
"custom_fields": [
\{
"key": "Years of Experience",
"value": "5"
\}
],
"recruiter": {
"email": "recruiter@company.com"
},
"activity_feed_notes": [
\{
"user_id": 67890,
"body": "Excellent candidate with strong technical skills",
"visibility": "private"
\}
],
"application": {
"job_ids": [
1001,
1002
],
"source_id": 5001,
"attachments": [
\{
"filename": "john_doe_resume.pdf",
"type2": "resume",
"content": "base64encodedcontent...",
"content_type": "application/pdf"
\}
]
}
}
Sample Output
Get application
Retrieve an application by its ID. Sample Input Sample Output
Get candidate
Retrieve a candidate by ID. Sample Input
{
"candidate_id": 12345
}
Sample Output
{
"candidate_found": true,
"body": {
"photo_url": null,
"addresses": [],
"applications": [
{
"credited_to": \{
"id": 67890,
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"employee_id": null
\},
"prospect_detail": \{
"prospect_pool": null,
"prospect_stage": null,
"prospect_owner": null
\},
"rejection_details": null,
"prospect": false,
"status": "active",
"rejected_at": null,
"answers": [],
"applied_at": "2023-05-15T10:30:00Z",
"location": null,
"jobs": [
\{
"id": 54321,
"name": "Software Engineer"
\}
],
"candidate_id": 12345,
"current_stage": \{
"id": 98765,
"name": "Phone Interview"
\},
"rejection_reason": null,
"last_activity_at": "2023-05-16T14:45:00Z",
"source": \{
"id": 11111,
"public_name": "Company Website"
\},
"id": 22222
}
],
"keyed_custom_fields": \{
"current_salary": null,
"desired_salary": null
\},
"employments": [],
"custom_fields": \{
"current_salary": null,
"desired_salary": null
\},
"application_ids": [
22222
],
"created_at": "2023-05-15T10:00:00Z",
"recruiter": null,
"educations": [],
"is_private": false,
"coordinator": null,
"attachments": [],
"last_name": "Smith",
"social_media_addresses": [],
"updated_at": "2023-05-16T14:45:00Z",
"title": null,
"last_activity": "2023-05-16T14:45:00Z",
"tags": [
"Java",
"Spring Boot"
],
"phone_numbers": [],
"first_name": "Alice",
"id": 12345,
"company": null,
"website_addresses": [],
"email_addresses": [
\{
"value": "alice.smith@example.com",
"type": "personal"
\}
]
}
}
Get current offer by application
Retrieve the current offer for an application. Sample Input
{
"application_id": 12345
}
Sample Output
{
"offer_found": true,
"body": {
"starts_at": "2023-07-01",
"keyed_custom_fields": {
"notes": \{
"name": "Notes",
"type": "text",
"value": null
\},
"salary": \{
"name": "Salary",
"type": "number",
"value": null
\},
"visa_cost": \{
"name": "Visa Cost",
"type": "number",
"value": null
\},
"employment_type": \{
"name": "Employment Type",
"type": "single_select",
"value": "Full-time"
\},
"current_salary": \{
"name": "Current Salary",
"type": "number",
"value": null
\},
"source_cost": \{
"name": "Source Cost",
"type": "number",
"value": null
\},
"benefits": \{
"name": "Benefits",
"type": "text",
"value": null
\},
"options": \{
"name": "Options",
"type": "text",
"value": null
\},
"bonus": \{
"name": "Bonus",
"type": "number",
"value": null
\}
},
"custom_fields": \{
"notes": null,
"salary": null,
"visa_cost": null,
"employment_type": "Full-time",
"current_salary": null,
"source_cost": null,
"benefits": null,
"options": null,
"bonus": null
\},
"created_at": "2023-06-15T10:30:00Z",
"application_id": 12345,
"status": "created",
"candidate_id": 67890,
"updated_at": "2023-06-15T10:30:00Z",
"version": 1,
"resolved_at": null,
"sent_at": null,
"id": 54321,
"job_id": 98765
}
}
Get job
Retrieve a job by its ID. Sample Input
{
"job_id": 12345
}
Sample Output
{
"job_found": true,
"body": {
"notes": null,
"departments": [
\{
"id": 1001,
"name": "Engineering",
"parent_id": null,
"child_ids": [
1002,
1003
],
"external_id": null
\},
\{
"id": 1002,
"name": "Frontend",
"parent_id": 1001,
"child_ids": [],
"external_id": null
\}
],
"keyed_custom_fields": {
"employment_type": \{
"name": "Employment Type",
"type": "single_select",
"value": null
\},
"salary": \{
"name": "Salary Range",
"type": "short_text",
"value": null
\},
"bonus": \{
"name": "Bonus",
"type": "short_text",
"value": null
\},
"options": \{
"name": "Stock Options",
"type": "yes_no",
"value": null
\}
},
"closed_at": null,
"custom_fields": \{
"employment_type": null,
"salary": null,
"bonus": null,
"options": null
\},
"confidential": false,
"opened_at": "2023-05-01T09:00:00Z",
"created_at": "2023-04-28T14:30:00Z",
"name": "Senior Frontend Developer",
"hiring_team": {
"hiring_managers": [],
"recruiters": [
\{
"id": 2001,
"first_name": "Jane",
"last_name": "Smith",
"name": "Jane Smith",
"employee_id": null,
"responsible": true
\}
],
"coordinators": [],
"sourcers": []
},
"status": "open",
"offices": [],
"id": 12345,
"openings": [
\{
"id": 5001,
"opening_id": null,
"status": "open",
"opened_at": "2023-05-01T09:00:00Z",
"closed_at": null,
"application_id": null,
"close_reason": null
\}
],
"requisition_id": null
}
}
Get offer
Retrieve an offer by its ID. Sample Input
{
"offer_id": 12345
}
Sample Output
Get user
Retrieve a user by ID. Sample Input
{
"user_id": 12345
}
Sample Output
List applications
Retrieve a list of application. Can be filtered if required. Sample Input
\{
"job_id": 12345,
"created_after": "2023-01-01T00:00:00Z",
"created_before": "2023-06-30T23:59:59Z",
"last_activity_after": "2023-05-01T00:00:00Z",
"status": "Active",
"results_per_page": 10,
"page": 1
\}
Sample Output
{
"results": [
{
"credited_to": null,
"prospect_detail": \{
"prospect_stage": null,
"prospect_pool": null,
"prospect_owner": null
\},
"rejection_details": null,
"prospect": false,
"status": "Active",
"rejected_at": null,
"answers": [],
"applied_at": "2023-05-15T14:30:00Z",
"location": null,
"jobs": [
\{
"name": "Software Engineer",
"id": 12345
\}
],
"candidate_id": 67890,
"current_stage": \{
"name": "Phone Screen",
"id": 1
\},
"rejection_reason": {
"type": \{
"name": null,
"id": null
\},
"name": null,
"id": null
},
"last_activity_at": "2023-06-01T10:15:00Z",
"source": \{
"public_name": "Company Website",
"id": 1
\},
"id": 54321
}
]
}
List candidates
Retrieve a list of candidates. Can be filtered if required. Sample Input
\{
"job_id": 12345,
"candidate_ids": [
"67890",
"78901"
],
"email": "johndoe@example.com",
"created_after": "2023-01-01T00:00:00Z",
"updated_before": "2023-06-30T23:59:59Z",
"results_per_page": 10,
"page": 1
\}
Sample Output
{
"results": [
{
"id": 67890,
"first_name": "John",
"last_name": "Doe",
"company": "ABC Corp",
"title": "Software Engineer",
"created_at": "2023-02-15T10:30:00Z",
"updated_at": "2023-06-20T14:45:00Z",
"last_activity": "2023-06-20T14:45:00Z",
"is_private": false,
"photo_url": null,
"attachments": [
\{
"filename": "john_doe_resume.pdf",
"url": "https://example.com/resumes/john_doe_resume.pdf",
"type": "resume"
\}
],
"application_ids": [
98765
],
"phone_numbers": [
\{
"value": "+1 555-123-4567",
"type": "mobile"
\}
],
"addresses": [
\{
"value": "123 Main St, Anytown, USA 12345",
"type": "home"
\}
],
"email_addresses": [
\{
"value": "johndoe@example.com",
"type": "personal"
\}
],
"website_addresses": [
\{
"value": "https://johndoe.com",
"type": "personal"
\}
],
"social_media_addresses": [
{
"value": "https://linkedin.com/in/johndoe"
}
],
"recruiter": \{
"id": 11111,
"first_name": "Jane",
"last_name": "Smith",
"name": "Jane Smith",
"employee_id": "EMP001"
\},
"coordinator": \{
"id": 22222,
"first_name": "Mike",
"last_name": "Johnson",
"name": "Mike Johnson",
"employee_id": "EMP002"
\},
"tags": [
"Java",
"Python",
"AWS"
],
"applications": [
{
"id": 98765,
"candidate_id": 67890,
"prospect": false,
"applied_at": "2023-06-01T09:00:00Z",
"rejected_at": null,
"last_activity_at": "2023-06-20T14:45:00Z",
"location": \{
"address": "456 Tech Ave, Silicon Valley, CA 94000"
\},
"source": \{
"id": 33333,
"public_name": "Company Website"
\},
"credited_to": \{
"id": 11111,
"first_name": "Jane",
"last_name": "Smith",
"name": "Jane Smith",
"employee_id": "EMP001"
\},
"rejection_reason": null,
"rejection_details": null,
"jobs": [
\{
"id": 12345,
"name": "Senior Software Engineer"
\}
],
"status": "active",
"current_stage": \{
"id": 44444,
"name": "Phone Interview"
\},
"answers": [
\{
"question": "Years of experience",
"answer": "5"
\}
],
"prospect_detail": \{
"prospect_pool": null,
"prospect_stage": null,
"prospect_owner": null
\}
}
],
"educations": [],
"employments": [],
"custom_fields": \{
"current_salary": null,
"desired_salary": null
\},
"keyed_custom_fields": \{
"current_salary": null,
"desired_salary": null
\}
}
]
}
List custom fields
Retrieve a list of custom fields. Sample Input Sample Output
{
"results": [
\{
"id": 1001,
"name": "Current Salary",
"active": true,
"field_type": "candidate",
"priority": 1,
"value_type": "short_text",
"private": true,
"required": false,
"require_approval": false,
"trigger_new_version": false,
"name_key": "current_salary",
"custom_field_options": []
\},
{
"id": 1002,
"name": "Preferred Work Location",
"active": true,
"field_type": "candidate",
"priority": 2,
"value_type": "multi_select",
"private": false,
"required": true,
"require_approval": false,
"trigger_new_version": true,
"name_key": "preferred_work_location",
"custom_field_options": [
\{
"id": 101,
"name": "Remote",
"priority": 1
\},
\{
"id": 102,
"name": "On-site",
"priority": 2
\},
\{
"id": 103,
"name": "Hybrid",
"priority": 3
\}
]
},
\{
"id": 1003,
"name": "Years of Experience",
"active": false,
"field_type": "candidate",
"priority": 3,
"value_type": "number",
"private": false,
"required": false,
"require_approval": false,
"trigger_new_version": false,
"name_key": "years_of_experience",
"custom_field_options": []
\}
]
}
List departments
List all of an organization’s departments. Sample Input
\{
"render_as": "tree",
"results_per_page": 10,
"page": 1
\}
Sample Output
List job stages
List all of an organization’s job stages. Sample Input
\{
"created_after": "2023-01-01T00:00:00Z",
"updated_before": "2023-06-30T23:59:59Z",
"per_page": 50,
"page": 1
\}
Sample Output
List job stages for job
Retrieve the stages for the specified job id. Sample Input
\{
"job_id": 12345,
"created_after": "2023-01-01T00:00:00Z",
"updated_before": "2023-06-30T23:59:59Z"
\}
Sample Output
{
"results": [
{
"id": 67890,
"name": "Phone Screen",
"created_at": "2023-02-15T10:30:00Z",
"updated_at": "2023-02-15T10:30:00Z",
"job_id": 12345,
"interviews": [
{
"id": 11111,
"name": "Initial Phone Interview",
"interview_kit": \{
"id": 22222,
"content": null,
"questions": []
\}
}
]
},
{
"id": 67891,
"name": "On-site Interview",
"created_at": "2023-02-15T10:31:00Z",
"updated_at": "2023-03-01T14:45:00Z",
"job_id": 12345,
"interviews": [
{
"id": 11112,
"name": "Technical Interview",
"interview_kit": \{
"id": 22223,
"content": null,
"questions": []
\}
},
{
"id": 11113,
"name": "Culture Fit Interview",
"interview_kit": \{
"id": 22224,
"content": null,
"questions": []
\}
}
]
}
]
}
List jobs
List all of an organization’s jobs. Sample Input Sample Output
{
"results": [
{
"id": 12345,
"name": "Software Engineer",
"requisition_id": "REQ-2023-001",
"notes": null,
"confidential": false,
"status": "open",
"created_at": "2023-02-15T10:30:00Z",
"opened_at": "2023-02-16T09:00:00Z",
"closed_at": null,
"departments": [
\{
"id": 67890,
"name": "Engineering",
"parent_id": null,
"child_ids": [],
"external_id": null
\}
],
"offices": [
{
"id": 54321,
"name": "San Francisco HQ",
"location": \{
"name": "San Francisco, CA"
\},
"primary_contact_user_id": 98765,
"parent_id": null,
"child_ids": [],
"external_id": null
}
],
"hiring_team": {
"hiring_managers": [
\{
"id": 11111,
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"employee_id": "EMP001"
\}
],
"recruiters": [
\{
"id": 22222,
"first_name": "Jane",
"last_name": "Smith",
"name": "Jane Smith",
"employee_id": "EMP002",
"responsible": true
\}
],
"coordinators": [],
"sourcers": []
},
"custom_fields": \{
"employment_type": "Full-time",
"salary": "$100,000 - $150,000",
"bonus": "10% - 20%",
"options": "10,000 RSUs",
"level": "Senior"
\},
"keyed_custom_fields": {
"employment_type": \{
"name": "Employment Type",
"type": "single_select",
"value": "Full-time"
\},
"salary": \{
"name": "Salary Range",
"type": "short_text",
"value": "$100,000 - $150,000"
\},
"bonus": \{
"name": "Bonus Range",
"type": "short_text",
"value": "10% - 20%"
\},
"options": \{
"name": "Stock Options",
"type": "short_text",
"value": "10,000 RSUs"
\},
"level": \{
"name": "Level",
"type": "single_select",
"value": "Senior"
\}
},
"openings": [
\{
"id": 33333,
"opening_id": null,
"status": "open",
"opened_at": "2023-02-16T09:00:00Z",
"closed_at": null,
"application_id": null,
"close_reason": null
\}
]
}
]
}
List offers
Retrieve a list of offers. Can be filtered if required. Sample Input Sample Output
{
"results": [
{
"starts_at": "2023-07-15T00:00:00Z",
"keyed_custom_fields": {
"salary_proposal": \{
"name": "Salary Proposal",
"type": "short_text",
"value": "95000"
\},
"department": \{
"name": "Department",
"type": "short_text",
"value": "Engineering"
\},
"location": \{
"name": "Location",
"type": "short_text",
"value": "San Francisco"
\},
"signing_bonus": \{
"name": "Signing Bonus",
"type": "short_text",
"value": "10000"
\},
"equity_grant_": \{
"name": "Equity Grant",
"type": "short_text",
"value": "10000 RSUs"
\}
},
"custom_fields": \{
"salary_proposal": "95000",
"department": "Engineering",
"location": "San Francisco",
"signing_bonus": "10000",
"equity_grant:": "10000 RSUs"
\},
"created_at": "2023-05-15T14:30:00Z",
"application_id": 67890,
"status": "accepted",
"updated_at": "2023-06-01T10:15:00Z",
"version": 2,
"resolved_at": "2023-06-01T10:15:00Z",
"sent_at": null,
"id": 54321
}
]
}
List offers by application
Retrieve a list of offers by application ID. Sample Input
\{
"application_id": 12345,
"results_per_page": 2,
"page": 1
\}
Sample Output
List offices
List all of an organization’s offices. Sample Input Sample Output
{
"offices": [
\{
"id": 1,
"name": "Headquarters",
"location": "New York",
"primary_contact_id": 101,
"parent_id": null
\},
\{
"id": 2,
"name": "West Coast Office",
"location": "San Francisco",
"primary_contact_id": 102,
"parent_id": 1
\},
\{
"id": 3,
"name": "European Office",
"location": "London",
"primary_contact_id": 103,
"parent_id": 1
\}
],
"meta": \{
"total": 3,
"page": 1,
"per_page": 10
\}
}
List sources
Lists an organization’s sources, grouped by strategy. Sample Input
\{
"per_page": 50,
"page": 1
\}
Sample Output
{
"results": [
{
"id": 1234,
"name": "LinkedIn",
"type": \{
"id": 1,
"name": "Social Media"
\}
},
{
"id": 5678,
"name": "Indeed",
"type": \{
"id": 2,
"name": "Job Board"
\}
},
{
"id": 9101,
"name": "Employee Referral",
"type": \{
"id": 3,
"name": "Internal"
\}
}
]
}
List users
Retrieve a list of users. Can be filtered if required. Sample Input
\{
"results_per_page": 2,
"page": 1,
"email": "john.doe@example.com",
"created_after": "2023-01-01T00:00:00Z",
"updated_before": "2023-06-30T23:59:59Z"
\}
Sample Output
{
"results": [
\{
"id": 12345,
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"updated_at": "2023-05-15T14:30:00Z",
"created_at": "2023-01-15T09:00:00Z",
"disabled": false,
"site_admin": false,
"emails": [
"john.doe@example.com"
],
"employee_id": "EMP001"
\},
\{
"id": 12346,
"name": "Jane Smith",
"first_name": "Jane",
"last_name": "Smith",
"updated_at": "2023-06-20T11:45:00Z",
"created_at": "2023-02-01T10:30:00Z",
"disabled": false,
"site_admin": true,
"emails": [
"jane.smith@example.com",
"j.smith@example.com"
],
"employee_id": "EMP002"
\}
]
}
DDL operations
List attachment content types (DDL)
Sample Input
{}
Sample Output
{
"result": [
\{
"text": "PDF",
"value": "application/pdf"
\},
\{
"text": "Word Document",
"value": "application/msword"
\},
\{
"text": "Image (JPEG)",
"value": "image/jpeg"
\},
\{
"text": "Image (PNG)",
"value": "image/png"
\},
\{
"text": "Plain Text",
"value": "text/plain"
\}
]
}
List candidate custom fields (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
List candidates (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"result": [
\{
"text": "John Doe",
"value": 1001
\},
\{
"text": "Jane Smith",
"value": 1002
\},
\{
"text": "Michael Johnson",
"value": 1003
\},
\{
"text": "Emily Brown",
"value": 1004
\},
\{
"text": "David Wilson",
"value": 1005
\}
]
}
List job custom field options (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{
"custom_field": 12345
}
Sample Output
{
"result": [
\{
"text": "Entry Level",
"value": 1
\},
\{
"text": "Mid Level",
"value": 2
\},
\{
"text": "Senior Level",
"value": 3
\},
\{
"text": "Executive",
"value": 4
\}
]
}
List job custom fields (DDL)
Sample Input
{}
Sample Output
{
"result": [
\{
"text": "Experience Level",
"value": 1
\},
\{
"text": "Required Skills",
"value": 2
\},
\{
"text": "Salary Range",
"value": 3
\},
\{
"text": "Remote Work Option",
"value": 4
\},
\{
"text": "Preferred Degree",
"value": 5
\}
]
}
List job stages for job (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{
"job_id": 12345
}
Sample Output
List jobs (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
List sources (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output
{
"result": [
\{
"text": "Job Board",
"value": 1
\},
\{
"text": "Employee Referral",
"value": 2
\},
\{
"text": "LinkedIn",
"value": 3
\},
\{
"text": "Company Website",
"value": 4
\},
\{
"text": "Recruitment Agency",
"value": 5
\}
]
}
List users (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"result": [
\{
"text": "John Doe",
"value": 1001
\},
\{
"text": "Jane Smith",
"value": 1002
\},
\{
"text": "Mike Johnson",
"value": 1003
\},
\{
"text": "Emily Brown",
"value": 1004
\},
\{
"text": "Chris Lee",
"value": 1005
\}
]
}