Recruitee API Documentation: Retrieving Job and Talent Pool
🕒 2025-04-27 10:13:59.206333What will you learn?
- Get all candidates
- Get a candidate by their ID
- Filter a candidate by their status
- Get a collection of the company’s offers – jobs and talent pools
- Get all candidates from the talent pool or jobs
- Get all logs
- When admin updated candidate fields (e.g. skills)
- When admin changed the candidate stage
- When admin assigned candidate to offer
- When admin de-assigned a candidate from the offer
- When the admin viewed a candidate
- When admin created a candidate
- When the admin deleted a candidate
- When admin disqualified a candidate
- When admin created an event request link
- When candidate field visibility changed
- Filter the logs by the created date
GET https://api.recruitee.com/c/:company_id/candidates
where
company_id: Settings → Apps and Plugins → Personal API tokens → Current company details
Authorization: Bearer <api_token> (Required for all API's)
Response
{
"candidates": [
{
"admin_id": 322453,
"adminapp_url": "https://app.recruitee.com/#/dashboard/overview?candidate=47628534&company=90598",
"created_at": "2023-02-07T07:09:08.809894Z",
"emails": [
"jaspritbumrah01@cricket.com"
],
"example": false,
"followed": false,
"has_avatar": true,
"id": 47628534,
"initials": "JB",
"last_message_at": null,
"my_last_rating": null,
"my_pending_result_request": false,
"my_upcoming_event": false,
"name": "Jasprit Bumrah",
"pending_result_request": false,
"phones": [],
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/47628534/thumb_photo_6ncy32n7kkcl.jpg",
"placements": [
{
"candidate_id": 47628534,
"created_at": "2023-02-07T07:09:47.246854Z",
"hired_at": null,
"hired_by_id": null,
"hired_in_other_placement": false,
"hired_in_this_placement": false,
"id": 50538859,
"job_starts_at": null,
"language": null,
"offer_id": 1209656,
"overdue_at": null,
"overdue_diff": null,
"position": 3,
"positive_ratings": null,
"ratings": {},
"stage_id": 8176678,
"updated_at": "2023-02-07T07:09:47.246854Z"
}
],
"positive_ratings": null,
"ratings": {},
"ratings_count": 0,
"referrer": null,
"source": "manual",
"tasks_count": 0,
"unread_notifications": false,
"upcoming_event": false,
"updated_at": "2023-02-09T09:10:25.218237Z",
"viewed": true
},
....
]
}Note: It will return only some of the property of each candidate. To fetch all the information, we have to pass the id of a particular candidate as below.
Get a candidate by their ID:
Get https://api.recruitee.com/c/:company_id/candidates/<id>
This will fetch the skills of that particular candidate and other information.
Response
{
"candidate": {
"tags": [],
"adminapp_url": "https://app.recruitee.com/#/dashboard/overview?candidate=47628534&company=90598",
"attachments_count": 0,
"tasks_count": 0,
"gdpr_consent_request_type": null,
"links": [],
"viewed": true,
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/47628534/thumb_photo_6ncy32n7kkcl.jpg",
"positive_ratings": null,
"gdpr_consent_request_sent_at": null,
"cv_original_url": null,
"id": 47628534,
"last_message_at": null,
"ratings_count": 0,
"gdpr_consent_request_completed_at": null,
"my_last_rating": null,
"admin_id": 322453,
"photo_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/47628534/normal_photo_6ncy32n7kkcl.jpg",
"source": "manual",
"updated_at": "2023-02-09T12:26:38.955473Z",
"pending_request_link": false,
"name": "Jasprit Bumrah",
"cv_processing_status": "ok",
"phones": [],
"unread_notifications": false,
"my_pending_result_request": false,
"sourcing_data": null,
"last_activity_at": "2023-02-09T12:26:38.974597Z",
"has_avatar": true,
"pending_result_request": false,
"initials": "JB",
"gdpr_consent_ever_given": false,
"open_question_answers": [],
"rating_visible": true,
"grouped_open_question_answers": [],
"example": false,
"gdpr_scheduled_to_delete_at": null,
"online_data": null,
"custom_fields": [],
"social_links": [],
"emails": [
"jaspritbumrah01@cricket.com"
],
"gdpr_status": "no_consent",
"duplicates": [
47628534
],
"sources": [],
"referral_referrers_ids": [],
"fields": [
{
"fixed": true,
"id": null,
"kind": "language_skill",
"options": {
"levels": [
"none",
"basic",
"intermediate",
"advanced",
"near_native",
"native"
]
},
"origin": "manual",
"values": [],
"visibility": {
"admin_ids": [],
"level": "public",
"role_ids": []
},
"visible": true
},
{
"fixed": true,
"id": 113039959,
"kind": "skills",
"origin": "manual",
"values": [
{
"text": "Microsoft Word"
},
{
"text": "Microsoft Office"
},
{
"text": "HTML"
}
],
"visibility": {
"admin_ids": [],
"level": "public",
"role_ids": []
},
"visible": true
},
{
"fixed": true,
"id": null,
"kind": "dropdown",
"name": "Specialization",
"options": {
"values": [
"Sourcing",
"Screening & Interviewing"
]
},
"origin": "manual",
"values": [],
"visibility": {
"admin_ids": [],
"level": "public",
"role_ids": []
},
"visible": true
},
{
"fixed": true,
"id": null,
"kind": "single_line",
"name": "Salary expectation",
"origin": "manual",
"values": [],
"visibility": {
"admin_ids": [
322384
],
"level": "protected",
"role_ids": [
541069,
541070,
541071
]
},
"visible": true
},
{
"fixed": true,
"id": null,
"kind": "education",
"origin": "manual",
"values": [],
"visibility": {
"admin_ids": [],
"level": "public",
"role_ids": []
},
"visible": true
},
{
"fixed": true,
"id": null,
"kind": "experience",
"origin": "manual",
"values": [],
"visibility": {
"admin_ids": [],
"level": "public",
"role_ids": []
},
"visible": true
}
],
"upcoming_event": false,
"cv_url": null,
"mailbox_messages_count": 0,
"gdpr_expires_at": null,
"created_at": "2023-02-07T07:09:08.809894Z",
"placements": [
{
"candidate_id": 47628534,
"created_at": "2023-02-07T07:09:47.246854Z",
"hired_at": null,
"hired_by_id": null,
"hired_in_other_placement": false,
"hired_in_this_placement": false,
"id": 50538859,
"job_starts_at": null,
"language": null,
"offer_id": 1209656,
"overdue_at": null,
"overdue_diff": null,
"position": 3,
"positive_ratings": null,
"rating_visible": true,
"ratings": {},
"stage_id": 8176678,
"updated_at": "2023-02-07T07:09:47.246854Z"
}
],
"followed": false,
"notes_count": 0,
"cover_letter": null,
"admin_ids": [],
"ratings": {},
"in_active_share": false,
"sourcing_origin": null,
"referrer": null,
"my_upcoming_event": false
},
"references": [
{
"department_id": 294698,
"guid": "ph6ak",
"id": 1209656,
"kind": "job",
"lang_code": "en",
"location": "Remote job",
"position": 2,
"slug": "recruiter-sample",
"status": "internal",
"title": "Recruiter (Sample)",
"type": "Offer"
},
{
"action_templates": [],
"category": "apply",
"created_at": "2023-01-31T08:15:23.201246Z",
"fair_evaluations_enabled": false,
"group": "applicants",
"id": 8176678,
"locked": true,
"name": "Applied",
"placements_count": null,
"position": -1,
"time_limit": null,
"type": "Stage",
"updated_at": "2023-01-31T08:15:23.201247Z"
},
{
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"has_avatar": false,
"id": 322453,
"initials": "IG",
"last_name": "Gautam",
"photo_normal_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/admins/322453/normal_avatar_rcy76v9yg2ly.png",
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/admins/322453/thumb_avatar_rcy76v9yg2ly.png",
"time_format24": true,
"timezone": "Asia/Kathmandu",
"type": "Admin"
}
]
}It will return all the property that belongs to this id. E.g. Candidate skills
Filter a candidate by their status:
GET https://api.recruitee.com/c/:company_id/search/new/candidates?filters_json=[{"field":"status","in":["disqualified"]}]
Note: filters_json takes an array of objects, so we can pass multiple objects at the same time to filter them based on different fields.
Response
{
"aggregations": null,
"hits": [
{
"gdpr_expires_at": null,
"tags": [],
"unread_notifications": false,
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/47318282/thumb_photo_y25v2sy7ur4h.png",
"rating": null,
"last_activity_at": "2023-02-07T07:11:21Z",
"new": false,
"id": 47318282,
"gdpr_status": null,
"deleted_by_name": null,
"has_avatar": false,
"gdpr_consent_ever_given": null,
"assigned_admins_ids": [],
"source": "manual",
"name": "Arjun Sharma",
"gdpr_uncompleted_change_request_created_at": null,
"sources": [],
"created_at": "2023-01-31T10:36:52Z",
"example": false,
"deleted": false,
"deleted_by": null,
"emails": [],
"gdpr_uncompleted_removal_request_created_at": null,
"updated_at": "2023-01-31T10:40:04Z",
"positive_ratings": null,
"highlight": null,
"placements": [
{
"disqualified": false,
"disqualified_at": null,
"disqualified_by": null,
"disqualified_by_name": null,
"disqualify_kind": null,
"disqualify_reason": null,
"eeo_data_status": null,
"hired_at": null,
"id": 50469664,
"is_hired": false,
"job_starts_at": null,
"offer": {
"id": 1209653,
"kind": "talent_pool",
"slug": "rising-stars-sample",
"status": "draft",
"title": "Rising stars (Sample)"
},
"overdue_at": null,
"overdue_diff": null,
"positive_ratings": null,
"rating_visible": true,
"stage": null
},
{
"disqualified": true,
"disqualified_at": "2023-02-07T07:11:21Z",
"disqualified_by": 322453,
"disqualified_by_name": "Ishwar Gautam",
"disqualify_kind": "admin",
"disqualify_reason": "Not a fit",
"eeo_data_status": null,
"hired_at": null,
"id": 50537777,
"is_hired": false,
"job_starts_at": null,
"offer": {
"id": 1209656,
"kind": "job",
"slug": "recruiter-sample",
"status": "internal",
"title": "Recruiter (Sample)"
},
"overdue_at": null,
"overdue_diff": null,
"positive_ratings": null,
"rating_visible": true,
"stage": {
"id": 8176680,
"name": "Evaluation",
"time_limit": null
}
}
],
"phones": [],
"soft_deleted_at": null,
"admin_id": 322453,
"company_id": 90598,
"rating_visible": true,
"initials": "AS",
"deleted_at": null
}
],
"total": 1
}We can filter candidates with respect to different fields. For more information, click here.
Get a collection of the company's offers - jobs and talent pools:
Get https://api.recruitee.com/c/:company_id/offers
{
"offers": [
{
"closed_at": null,
"candidates_count": 2,
"job_scheduler": null,
"status": "archived",
"url": "https://saugat.recruitee.com/o/next-recruitment-q3-sample",
"number_of_openings": null,
"example": true,
"has_active_campaign": false,
"id": 1209652,
"enabled_for_referrals": false,
"eeo_settings": null,
"position": null,
"slug": "next-recruitment-q3-sample",
"hired_candidates_count": 0,
"issues": {
"is_required_data_filled": false,
"is_required_data_missing": true,
"is_requisition_missing": true,
"is_requisition_present": false
},
"offer_tags": [],
"hiring_manager_id": null,
"pipeline_template": null,
"guid": "mk46o",
"mailbox_email": "job.mk46o@saugat.recruitee.com",
"created_at": "2023-01-31T08:15:23.094934Z",
"recruiter_id": null,
"followers": [],
"postal_code": null,
"shared_openings_count": null,
"kind": "talent_pool",
"city": null,
"published_at": null,
"followed": false,
"careers_url": "https://saugat.recruitee.com/o/next-recruitment-q3-sample",
"employment_type": null,
"street": null,
"updated_at": "2023-02-01T08:17:14.434673Z",
"location": "",
"department_id": 294699,
"pipeline": false,
"hired_candidates_without_openings_count": null,
"country_code": null,
"title": "Next recruitment - Q3 (Sample)",
"state_name": "",
"qualified_candidates_count": 2,
"enabled_languages": [
{
"code": "en",
"name": "English",
"native_name": "English"
}
],
"adminapp_url": "https://app.recruitee.com/#/offers/next-recruitment-q3-sample",
"state_code": null,
"department": "Marketing",
"disqualified_candidates_count": 0
},
{
"closed_at": null,
"candidates_count": 1,
"job_scheduler": null,
"status": "archived",
"url": "https://saugat.recruitee.com/o/marketer-sample",
"number_of_openings": null,
"example": true,
"has_active_campaign": false,
"id": 1209657,
"enabled_for_referrals": false,
"eeo_settings": null,
"position": 2,
"lang_code": "en",
"slug": "marketer-sample",
"hired_candidates_count": 0,
"issues": {
"is_required_data_filled": false,
"is_required_data_missing": true,
"is_requisition_missing": true,
"is_requisition_present": false
},
"offer_tags": [
"Sample",
"Mid-level",
"Remote"
],
"hiring_manager_id": null,
"pipeline_template": {
"category": null,
"custom": false,
"default": true,
"id": 663996,
"position": null,
"requires_adjustment": false,
"stages": [
{
"action_templates": [],
"category": "referred",
"fair_evaluations_enabled": false,
"group": "applicants",
"id": 8176660,
"locked": true,
"name": "Referred",
"placements_count": null,
"position": -3,
"time_limit": null
},
{
"action_templates": [],
"category": "sourced",
"fair_evaluations_enabled": false,
"group": "applicants",
"id": 8176661,
"locked": true,
"name": "Sourced",
"placements_count": null,
"position": -2,
"time_limit": null
},
{
"action_templates": [],
"category": "apply",
"fair_evaluations_enabled": false,
"group": "applicants",
"id": 8176662,
"locked": true,
"name": "Applied",
"placements_count": null,
"position": -1,
"time_limit": null
},
{
"action_templates": [],
"category": "phone_screen",
"fair_evaluations_enabled": false,
"group": "active",
"id": 8176663,
"locked": false,
"name": "Phone interview",
"placements_count": null,
"position": 1,
"time_limit": null
},
{
"action_templates": [],
"category": "interview",
"fair_evaluations_enabled": false,
"group": "active",
"id": 8176664,
"locked": false,
"name": "On-site interview",
"placements_count": null,
"position": 2,
"time_limit": null
},
{
"action_templates": [],
"category": "evaluation",
"fair_evaluations_enabled": false,
"group": "active",
"id": 8176665,
"locked": false,
"name": "Evaluation",
"placements_count": null,
"position": 3,
"time_limit": null
},
{
"action_templates": [],
"category": "offer",
"fair_evaluations_enabled": false,
"group": "active",
"id": 8176666,
"locked": false,
"name": "Offer",
"placements_count": null,
"position": 4,
"time_limit": null
},
{
"action_templates": [],
"category": "hire",
"fair_evaluations_enabled": false,
"group": "hires",
"id": 8176667,
"locked": false,
"name": "Hired",
"placements_count": null,
"position": 5,
"time_limit": null
}
],
"title": "Default"
},
"guid": "h7aek",
"mailbox_email": "job.h7aek@saugat.recruitee.com",
"created_at": "2023-01-31T08:15:23.180434Z",
"recruiter_id": null,
"followers": [],
"postal_code": "01-001",
"shared_openings_count": null,
"kind": "job",
"city": "London",
"published_at": null,
"followed": false,
"careers_url": "https://saugat.recruitee.com/o/marketer-sample",
"employment_type": "fulltime",
"street": null,
"updated_at": "2023-01-31T08:15:47.339062Z",
"location": "London, United Kingdom",
"department_id": 294699,
"pipeline": false,
"hired_candidates_without_openings_count": null,
"country_code": "GB",
"title": "Marketer (Sample)",
"state_name": null,
"qualified_candidates_count": 1,
"enabled_languages": [
{
"code": "en",
"name": "English",
"native_name": "English"
}
],
"adminapp_url": "https://app.recruitee.com/#/offers/marketer-sample",
"state_code": "LND",
"department": "Marketing",
"disqualified_candidates_count": 0
}
]
}Get only jobs
https://api.recruitee.com/c/:company_id/offers?kind=job
Get only talent-pools
https://api.recruitee.com/c/:company_id/offers?kind=talent_pool
Get all candidates from the talent pool or jobs:
Get https://api.recruitee.com/c/:company_id/candidates?offer_id=<id>
{
"candidates": [
{
"admin_id": 322453,
"adminapp_url": "https://app.recruitee.com/#/dashboard/overview?candidate=47318282&company=90598",
"created_at": "2023-01-31T10:36:52.041782Z",
"emails": [],
"example": false,
"followed": false,
"has_avatar": false,
"id": 47318282,
"initials": "AS",
"last_message_at": null,
"my_last_rating": null,
"my_pending_result_request": false,
"my_upcoming_event": false,
"name": "Arjun Sharma",
"pending_result_request": false,
"phones": [],
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/47318282/thumb_photo_y25v2sy7ur4h.png",
"placements": [
{
"candidate_id": 47318282,
"created_at": "2023-02-06T08:18:51.659338Z",
"hired_at": null,
"hired_by_id": null,
"hired_in_other_placement": false,
"hired_in_this_placement": false,
"id": 50469664,
"job_starts_at": null,
"language": null,
"offer_id": 1209653,
"overdue_at": null,
"overdue_diff": null,
"position": 6,
"positive_ratings": null,
"ratings": {},
"stage_id": null,
"updated_at": "2023-02-06T08:18:51.659338Z"
},
{
"candidate_id": 47318282,
"created_at": "2023-02-07T06:29:57.816763Z",
"disqualify_kind": "admin",
"disqualify_reason": "Not a fit",
"hired_at": null,
"hired_by_id": null,
"hired_in_other_placement": false,
"hired_in_this_placement": false,
"id": 50537777,
"job_starts_at": null,
"language": null,
"offer_id": 1209656,
"overdue_at": null,
"overdue_diff": null,
"position": 1,
"positive_ratings": null,
"ratings": {},
"stage_id": 8176680,
"updated_at": "2023-02-07T07:11:21.475526Z"
}
],
"positive_ratings": null,
"ratings": {},
"ratings_count": 0,
"referrer": null,
"source": "manual",
"tasks_count": 0,
"unread_notifications": false,
"upcoming_event": false,
"updated_at": "2023-01-31T10:40:04.184694Z",
"viewed": true
},
{
"admin_id": null,
"adminapp_url": "https://app.recruitee.com/#/dashboard/overview?candidate=47308506&company=90598",
"created_at": "2023-01-15T08:15:23.218162Z",
"emails": [
"johndoe@recruiteemail.com"
],
"example": true,
"followed": false,
"has_avatar": true,
"id": 47308506,
"initials": "JD",
"last_message_at": null,
"my_last_rating": null,
"my_pending_result_request": false,
"my_upcoming_event": false,
"name": "John Doe (Sample)",
"pending_result_request": false,
"phones": [
"+15555555555"
],
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/47308506/thumb_photo_dwnreupyp7ry.jpg",
"placements": [
{
"candidate_id": 47308506,
"created_at": "2023-02-06T07:56:06.724315Z",
"hired_at": null,
"hired_by_id": null,
"hired_in_other_placement": false,
"hired_in_this_placement": false,
"id": 50467996,
"job_starts_at": null,
"language": null,
"offer_id": 1209653,
"overdue_at": null,
"overdue_diff": null,
"position": 3,
"positive_ratings": null,
"ratings": {},
"stage_id": null,
"updated_at": "2023-02-06T07:56:06.724315Z"
},
{
"candidate_id": 47308506,
"created_at": "2023-01-15T08:15:23.218162Z",
"hired_at": null,
"hired_by_id": null,
"hired_in_other_placement": false,
"hired_in_this_placement": false,
"id": 50181296,
"job_starts_at": null,
"language": null,
"offer_id": 1209655,
"overdue_at": null,
"overdue_diff": null,
"position": 1,
"positive_ratings": null,
"ratings": {},
"stage_id": 8176671,
"updated_at": "2023-02-08T08:21:17.652758Z"
}
],
"positive_ratings": null,
"ratings": {},
"ratings_count": 0,
"referrer": "Indeed",
"source": "career_site",
"tasks_count": 0,
"unread_notifications": false,
"upcoming_event": false,
"updated_at": "2023-01-15T08:15:23.218162Z",
"viewed": true
},
{
"admin_id": null,
"adminapp_url": "https://app.recruitee.com/#/dashboard/overview?candidate=47308538&company=90598",
"created_at": "2023-01-10T08:15:44.197160Z",
"emails": [
"zacherybahringer@recruiteemail.com"
],
"example": true,
"followed": false,
"has_avatar": true,
"id": 47308538,
"initials": "ZB",
"last_message_at": null,
"my_last_rating": null,
"my_pending_result_request": false,
"my_upcoming_event": false,
"name": "Zachery Bahringer (Sample)",
"pending_result_request": false,
"phones": [
"+15555555555"
],
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/47308538/thumb_photo_knfvrsnsgk1u.jpg",
"placements": [
{
"candidate_id": 47308538,
"created_at": "2023-01-10T08:15:44.197160Z",
"hired_at": null,
"hired_by_id": null,
"hired_in_other_placement": false,
"hired_in_this_placement": false,
"id": 50181326,
"job_starts_at": null,
"language": null,
"offer_id": 1209653,
"overdue_at": null,
"overdue_diff": null,
"position": 1,
"positive_ratings": null,
"ratings": {},
"stage_id": null,
"updated_at": "2023-01-10T08:15:44.197160Z"
}
],
"positive_ratings": 75,
"ratings": {
"yes": 1
},
"ratings_count": 1,
"referrer": "Indeed",
"source": "career_site",
"tasks_count": 1,
"unread_notifications": false,
"upcoming_event": false,
"updated_at": "2023-01-10T08:15:44.197160Z",
"viewed": true
}
],
"generated_at": "2023-02-10T03:52:18.262626Z",
"references": [
{
"department_id": 294698,
"guid": "ph6ak",
"id": 1209656,
"kind": "job",
"lang_code": "en",
"location": "Remote job",
"position": 2,
"slug": "recruiter-sample",
"status": "internal",
"title": "Recruiter (Sample)",
"type": "Offer"
},
{
"category": "evaluation",
"created_at": "2023-01-31T08:15:23.201253Z",
"fair_evaluations_enabled": false,
"group": "active",
"id": 8176680,
"locked": false,
"name": "Evaluation",
"placements_count": null,
"position": 3,
"time_limit": null,
"type": "Stage",
"updated_at": "2023-01-31T08:15:23.201254Z"
},
{
"department_id": 294697,
"guid": "63urn",
"id": 1209653,
"kind": "talent_pool",
"location": "",
"position": null,
"slug": "rising-stars-sample",
"status": "draft",
"title": "Rising stars (Sample)",
"type": "Offer"
},
{
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"has_avatar": false,
"id": 322453,
"initials": "IG",
"last_name": "Gautam",
"photo_normal_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/admins/322453/normal_avatar_rcy76v9yg2ly.png",
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/admins/322453/thumb_avatar_rcy76v9yg2ly.png",
"time_format24": true,
"timezone": "Asia/Kathmandu",
"type": "Admin"
},
{
"department_id": 294699,
"guid": "gl7y1",
"id": 1209655,
"kind": "job",
"lang_code": "en",
"location": "New York, United States",
"position": 4,
"slug": "senior-marketer-sample-london",
"status": "published",
"title": "Senior Marketer (Sample)",
"type": "Offer"
},
{
"category": "phone_screen",
"created_at": "2023-01-31T08:15:23.201249Z",
"fair_evaluations_enabled": false,
"group": "active",
"id": 8176671,
"locked": false,
"name": "Phone interview",
"placements_count": null,
"position": 1,
"time_limit": null,
"type": "Stage",
"updated_at": "2023-01-31T08:15:23.201250Z"
}
]
}Get all logs:
Get https://api.recruitee.com/c/:company_id/audit_log
It will display all the changes in the application. Like when a candidate is created, deleted, assigned a job or talent pool, and so on.
When admin updated candidate fields (e.g. skills)
{
"_id": "9Y5wNYYBiDdvSIAhuLrO",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": null,
"company_id": 90598,
"created_at": "2023-02-09T09:10:25Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"field": {
"candidate_id": 47628534,
"id": 113039959,
"kind": "skills",
"name": null,
"options": {},
"origin": "manual",
"values": [
{
"text": "Python"
},
{
"text": "React"
}
]
},
"previous_field": {
"candidate_id": 47628534,
"id": 113039959,
"kind": "skills",
"name": null,
"options": {},
"origin": "manual",
"values": [
{
"text": "Python"
}
]
}
},
"event_name": "Admin updated candidate field",
"highlight": null,
"ip_address": "103.167.233.20",
"offer": null
}When admin changed candidate stage:
{
"_id": "f_odMIYBWfTYMG3cYlnj",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": null,
"company_id": 90598,
"created_at": "2023-02-08T08:21:17Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"placement": {
"candidate_id": 47308506,
"id": 50181296,
"lang_code": null,
"offer_id": 1209655,
"overdue_at": null,
"positive_ratings": null,
"ratings": {},
"stage_id": 8176671
},
"previous_stage": {
"category": "apply",
"id": 8176670,
"name": "Applied",
"pipeline_template_id": 663997,
"time_limit": null
},
"stage": {
"category": "phone_screen",
"id": 8176671,
"name": "Phone interview",
"pipeline_template_id": 663997,
"time_limit": null
}
},
"event_name": "Admin changed candidate stage",
"highlight": null,
"ip_address": "103.167.233.22",
"offer": null
},When admin assigned candidate to offer:
{
"_id": "WoC1KoYBiDdvSIAhj7N9",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": {
"emails": [
"jaspritbumrah01@cricket.com"
],
"id": 47628534,
"name": "Jasprit Bumrah"
},
"company_id": 90598,
"created_at": "2023-02-07T07:09:47Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": {
"emails": [
"jaspritbumrah01@cricket.com"
],
"id": 47628534,
"name": "Jasprit Bumrah"
},
"offer": {
"id": 1209656,
"kind": "job",
"primary_lang_code": "en",
"slug": "recruiter-sample",
"status": "internal",
"title": "Recruiter (Sample)"
},
"action": null,
"placement": {
"candidate_id": 47628534,
"id": 50538859,
"lang_code": null,
"offer_id": 1209656,
"overdue_at": null,
"positive_ratings": null,
"ratings": {},
"stage_id": 8176678
}
},
"event_name": "Admin assigned candidate to offer",
"highlight": null,
"ip_address": "103.167.233.83",
"offer": {
"id": 1209656,
"kind": "job",
"primary_lang_code": "en",
"slug": "recruiter-sample",
"status": "internal",
"title": "Recruiter (Sample)"
}
},When admin de-assigned candidate from the offer:
{
"_id": "je--JYYBWfTYMG3cHJsF",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": null,
"company_id": 90598,
"created_at": "2023-02-06T08:01:01Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"placement": {
"candidate_id": 47308531,
"id": 50181321,
"lang_code": null,
"offer_id": 1209655,
"overdue_at": null,
"positive_ratings": null,
"ratings": {},
"stage_id": 8176670
}
},
"event_name": "Admin deassigned candidate from offer",
"highlight": null,
"ip_address": "103.167.233.5",
"offer": null
}When admin viewed candidate:
{
"_id": "Uau1KoYBjAGyTaM8eOi1",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": {
"emails": [
"jaspritbumrah01@cricket.com"
],
"id": 47628534,
"name": "Jasprit Bumrah"
},
"company_id": 90598,
"created_at": "2023-02-07T07:09:41Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": {
"emails": [
"jaspritbumrah01@cricket.com"
],
"id": 47628534,
"name": "Jasprit Bumrah"
}
},
"event_name": "Admin viewed candidate",
"highlight": null,
"ip_address": "103.167.233.83",
"offer": null
},When admin created candidate:
{
"_id": "hqu0KoYBjAGyTaM8_efJ",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": {
"emails": [
"jaspritbumrah01@cricket.com"
],
"id": 47628534,
"name": "Jasprit Bumrah"
},
"company_id": 90598,
"created_at": "2023-02-07T07:09:09Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": {
"emails": [
"jaspritbumrah01@cricket.com"
],
"id": 47628534,
"name": "Jasprit Bumrah"
}
},
"event_name": "Admin created candidate",
"highlight": null,
"ip_address": "103.167.233.83",
"offer": null
},When admin deleted candidate:
{
"_id": "pquwKoYBjAGyTaM85-Ja",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": {
"emails": [
"mikellang@recruiteemail.com"
],
"id": 47308526,
"name": "Mikel Lang (Sample)"
},
"company_id": 90598,
"created_at": "2023-02-07T07:04:42Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": {
"emails": [
"mikellang@recruiteemail.com"
],
"id": 47308526,
"name": "Mikel Lang (Sample)"
},
"offers": [
{
"id": 1209653,
"kind": "talent_pool",
"primary_lang_code": null,
"slug": "rising-stars-sample",
"status": "draft",
"title": "Rising stars (Sample)"
},
{
"id": 1209656,
"kind": "job",
"primary_lang_code": "en",
"slug": "recruiter-sample",
"status": "internal",
"title": "Recruiter (Sample)"
}
]
},
"event_name": "Admin deleted candidate",
"highlight": null,
"ip_address": null,
"offer": null
},When admin disqualified candidate:
{
"_id": "XXa2KoYBcyJdvcla_1qL",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": null,
"company_id": 90598,
"created_at": "2023-02-07T07:11:21Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"disqualify_reason": {
"id": 727738,
"name": "Not a fit"
},
"placement": {
"candidate_id": 47318282,
"id": 50537777,
"lang_code": null,
"offer_id": 1209656,
"overdue_at": null,
"positive_ratings": null,
"ratings": {},
"stage_id": 8176680
}
},
"event_name": "Admin disqualified candidate",
"highlight": null,
"ip_address": null,
"offer": null
}When admin created event request link:
{
"_id": "z46qKoYBnNYXiNAQAwRU",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": null,
"company_id": 90598,
"created_at": "2023-02-07T06:57:10Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"interview_request_link": {
"email": "nickmills@recruiteemail.com",
"id": 2863186,
"interview_schedule_id": 57986,
"interview_template_id": null
}
},
"event_name": "Admin created event request link",
"highlight": null,
"ip_address": null,
"offer": null
}When candidate field visibility changed:
{
"_id": "oae-JYYBjAGyTaM8HEj6",
"actor": "System",
"actor_type": "system",
"admin": null,
"candidate": null,
"company_id": 90598,
"created_at": "2023-02-06T08:01:01Z",
"details": {
"field": {
"candidate_id": 47308531,
"id": 111578632,
"kind": "boolean",
"name": "Available from May?",
"options": {},
"origin": "manual",
"values": [
{
"flag": true
}
]
}
},
"event_name": "Candidate field visibility changed",
"highlight": null,
"ip_address": null,
"offer": null
}
Filter the logs by created date:
GET https://api.recruitee.com/c/:company_id/audit_log?filters_json=[{ "field": "created_at", "gte": 1675750344, "lte":1675750741}]
Where gte = greater than or equal to (takes a date in epochs),
And lte = less than or equal to (in epochs)
Note:
- The Unix epoch is the number of seconds that have elapsed since January 1, 1970, at midnight UTC time minus the leap seconds.
- There are a lot of online tools available to convert human-readable date to epochs. For e.g. epochconverter.com
Response
{
"aggregations": null,
"entries": [
{
"_id": "x42HKoYBnNYXiNAQFPGP",
"actor": "Ishwar Gautam",
"actor_type": "admin",
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"candidate": null,
"company_id": 90598,
"created_at": "2023-02-07T06:19:01Z",
"details": {
"admin": {
"email": "ishwar0123@gmail.com",
"first_name": "Ishwar",
"id": 322453,
"last_name": "Gautam"
},
"placement": {
"candidate_id": 47308510,
"id": 50181299,
"lang_code": null,
"offer_id": 1209655,
"overdue_at": null,
"positive_ratings": null,
"ratings": {},
"stage_id": 8176671
},
"previous_stage": {
"category": "apply",
"id": 8176670,
"name": "Applied",
"pipeline_template_id": 663997,
"time_limit": null
},
"stage": {
"category": "phone_screen",
"id": 8176671,
"name": "Phone interview",
"pipeline_template_id": 663997,
"time_limit": null
}
},
"event_name": "Admin changed candidate stage",
"highlight": null,
"ip_address": "103.167.233.84",
"offer": null
}
],
"total": 1
}Note: Possible FilterGroups:
- { field: ‘all’, query: string }
- { field: ‘created_at’, gte: string | number, lte: string | number}
- { field: ‘actor’, in: string, not_in: string}
For more information, refer here.
Comments
Loading comments...
Leave a Comment