Hiretual API (Sandbox)


The Hiretual API will allow you to sync projects, candidates, and your hiring process. Using Hiretual API, customers can create a custom integration workflow for their ATS or CRM.


Table of Contents


Candidates

HiringProcesses

Projects


Authenticate

To access the API, you will need API Key and Client Id. Your API Key and Client Id can be found in the Settings -> API Credentials section of your Hiretual account.


You authenticate to Hiretual API by providing X-API-KEY and X-CLIENT-ID headers to your API requests. You must authenticate for all the requests and all API requests must be made over HTTPS.

Partner With Hiretual

Please fill out this form and our partner team will get in touch with you to kick off the partnership.

Candidates

Create a new candidate

Request body

Body Parameter — Candidate JSON Body Parameters
Content-Type: application/json
{
  "fullname": "Brian Williams",
  "primary_email": "[email protected]",
  "extra_emails": ["[email protected]","[email protected]"],
  "work_authorization": null,
  "phone_number": 8888888888,
  "industry": "software",
  "image_url": "https://hiretual.s3.amazonaws.com/example",
  "indeed_url": "http://indeed.com/example",
  "candidate_summary": "CEO",
  "linkedin_url": "http://www.linkedin/in/sample",
  "linkedin_id": null,
  "location": "CA,USA",
  "address": "No.1 Sample Street",
  "current_company": "Hiretual",
  "current_title": "Engineer",
  "google_scholar_id": null,
  "facebook_url": "https://www.facebook.com/example",
  "twitter_url": "https://twitter.com/example",
  "angellist_url": "https://www.angel.co/example",
  "stackoverflow_url": "https://stackoverflow.com/example",
  "github_url": "https://www.github.com/example",
  "crunchbase_url": "https://crunchbase.com/example",
  "skype": "https://skype.com/example",
  "website": "https://example.com",
  "candidate_profile_url": "https://app.hiretual.com/example",
  "resume_url": "https://hiretual.s3.amazonaws.com/example(pdf,doc,docx)",
  "education": [
    {
      "education_school": "School Name",
      "education_major": "SC",
      "education_gpa": 4,
      "education_startyear": 2010,
      "education_endyear": 2014,
      "education_description": null,
      "education_activities": null
    }
  ],
  "position": [
    {
      "position_company": "Company Name",
      "position_title": "Engineer",
      "position_start_date": "2017-01-01T00:00:00.000Z",
      "position_end_date": "2019-01-01T00:00:00.000Z",
      "position_iscurrent": true
    }
  ]
}

Responses

201

Candidate information
{
  "id": "g636a294ea7865fd95.1343423420"
}

400

invalid input, object invalid

Get candidate information by candidate id

Path parameters

id (required)
Path Parameter — candidate id

Responses

200

Candidate information
{
  "basic" : {
    "fullname" : "Brian Williams",
    "primary_email" : "[email protected]",
    "phone_number" : "8888888888",
    "location" : "Greater St. Louis Area",
    "country" : "United States",
    "fmt_location" : "Greater St. Louis Area, Missouri, United States",
    "opt_out" : false,
    "city" : "St. Louis",
    "current_position" : {
      "normed_domain" : "dynatrace.com",
      "position_iscurrent" : true,
      "position_summary" : "Drive a multi-million dollar revenue stream for a SaaS, AI-based, highly automated application monitoring platform. Developed a routine outbound cadence of customer outreach based on phone, e-mail, direct mail, and dimensional mail campaigns. Focus on helping accounts achieve their strategic objectives, improving operational efficiencies, and improving customer experience. Call on a target list of enterprise accounts of existing and new accounts.  • FY 2019: President’s Club • FY 2019: 109% Revenue attainment • FY 2019: 261% New account revenue • FY 2019: 157% Services revenue • FY 2018: President’s Club • FY 2018: Rookie of the Year • FY 2018: 161% Revenue attainment • FY 2018: 145% Services revenue\n",
      "position_start_date" : "2019-01-01T00:00:00.000Z",
      "position_title" : "Account Executive",
      "position_location" : "Greater St. Louis Area",
      "position_end_date" : "2019-01-01T00:00:00.000Z",
      "position_company_logo" : "Position Company Logo",
      "position_company_name" : "Alps Automotive",
      "position_company_website_url" : "dynatrace.com"
    },
    "highest_education" : {
      "education_endyear" : 1995,
      "education_major" : "Business Administration",
      "education_school" : "University of Missouri-Saint Louis",
      "education_description" : "Graduate curricula: Ergonomics, Project Management, Industrial Cost Analysis and Capital Budgeting, Mfg. Planning and Control, Statistics, Factory Optimization, and Work Measurement Science",
      "education_degree_level" : "Education Degree Level",
      "education_startyear" : 1990,
      "education_degree" : "Bachelor of Science",
      "education_school_logo" : "Education School Logo"
    },
    "gdpr_email" : {
      "guess" : [ "[email protected]", "[email protected]" ],
      "company" : [ "company", "company" ]
    },
    "client_id" : "htmtalent",
    "stackoverflow_url" : "https://stackoverflow.com/example",
    "edited_fullname" : "Edited Fullname",
    "highlight" : "Results focused sales professional with a record of producing revenue in highly competitive markets. Proven success developing new and underperforming territories. Thorough understanding of Solution Selling and selling business value. Actively listen to customers and align new technology solutions to help them achieve their business goals. Effective at managing complex sales processes and working with large companies. Organize and collaborate with the sales team and business partners to timely complete customer deliverables and maintain sales momentum.  Comprehensive knowledge of a wide range of software applications: ERP (Accounting, CRM, HR, and more), Business Intelligence, Enterprise and Consumer Portals, Collaboration, E-Commerce, and Infrastructure systems. Proficient selling SaaS cloud and hybrid cloud solutions.\n",
    "resume_file_url" : "https://hiretual.s3.amazonaws.com/example",
    "current" : "Sap",
    "user_create_date" : "2016-07-18T20:40:22.000Z",
    "google_scholar_id" : "Google Scholar Id",
    "skill" : [ "enterprise software", "enterprise software" ],
    "state" : "Missouri",
    "edited_phone_number" : "Edited Phone Number",
    "twitter_url" : "https://twitter.com/example",
    "angellist_url" : "https://www.angel.co/example",
    "crunchbase_url" : "https://crunchbase.com/example",
    "email" : "[email protected]",
    "facebook_url" : "https://www.facebook.com/example",
    "work_auth" : "Work Authorization",
    "website" : "https://example.com",
    "career_path" : "Information Technology & Services",
    "image_url" : "https://hiretual.s3.amazonaws.com/example",
    "default_emails" : [ "[email protected]", "[email protected]" ],
    "extra_email" : [ "[email protected]", "[email protected]" ],
    "linkedin_id" : 9983762,
    "is_edited" : false,
    "indeed_url" : "http://indeed.com/example",
    "edited_email" : [ "[email protected]", "[email protected]" ],
    "github_url" : "https://www.github.com/example",
    "user_id" : "fu588dg6b6bbed13.79673477",
    "gdpr_status" : "Gdpr Status",

    "linkedin_url" : "https://www.linkedin.com/in/example",
    "user_update_date" : "2016-07-18T20:40:22.000Z",
    "current_title" : "Software Sales Representative | Enterprise Account Executive"
  },
  "education" : [
    {
      "education_school": "School Name",
      "education_major": "SC",
      "education_gpa": 4,
      "education_startyear": 2010,
      "education_endyear": 2014,
      "education_description": null,
      "education_activities": null
    }
  ],
  "patent" : [
    {
      "patent_description" : "Patent Description",
      "patent_issuer" : "Patent Issuer",
      "patent_issuer_country" : "Patent Issuer Country",
      "patent_url" : "Patent URL",
      "patent_year" : 6,
      "patent_title" : "Patent Title",
      "patent_tracking_number" : "Patent Tracking Number"
    }
  ],
  "handson" : [
    {
      "handson_skill" : "Solution Selling",
      "handson_linkedin_endorsements" : 54
    }, {
      "handson_skill" : "Solution Selling",
      "handson_linkedin_endorsements" : 54
    }
  ],
  "project" : [ "project", "project" ],
  "recommendation" : [
    {
      "recommendation_recommendation" : "Recommendation Recommendation",
      "recommendation_type" : "Recommendation Type"
    }, {
      "recommendation_recommendation" : "Recommendation Recommendation",
      "recommendation_type" : "Recommendation Type"
    }
  ],
  "language" : [
    {
      "language_name" : "Language Name",
      "language_proficiency" : "Language Proficiency"
    }, {
      "language_name" : "Language Name",
      "language_proficiency" : "Language Proficiency"
    }
  ],
  "sourcing_channels" : [ "hiretual", "hiretual" ],
  "certification" : [
    {
      "certification_iscurrent" : true,
      "certification_country" : "Certification Country",
      "certification_name" : "Certification Name",
      "certification_start_date" : "Certification Start Date",
      "certification_license_number" : "Certification License Number",
      "certification_authority" : "Certification Authority",
      "certification_company" : "Certification Company",
      "certification_state" : "Certification State",
      "certification_end_date" : "Certification End Date",
      "certification_description" : "Certification Description"
    }
  ],
  "application_id_list" : [ "Application Id", "Application Id" ],
  "award" : [
    {
      "award_issuer" : "Award Issuer",
      "award_name" : "Award Name",
      "award_description" : "Award Description",
      "award_year" : 0
    }
  ],
  "volunteer" : [
    {
      "volunteer_name" : "Volunteer Name",
      "volunteer_description" : "Volunteer Description"
    }
  ],
  "organization" : [
    {
      "organization_end_date" : "Organization End Date",
      "organization_description" : "Organization Description",
      "organization_iscurrent" : true,
      "organization_position" : "Organization Position",
      "organization_name" : "Organization Name",
      "organization_start_date" : "Organization Start Date"
    }
  ],
  "publication" : [
    {
      "publication_year" : "Publication Year",
      "publication_description" : "Publication Description",
      "publication_organization" : "Publication Organization",
      "publication_title" : "Publication Title",
      "publication_citation" : "Publication Citation",
      "publication_url" : "Publication URL"
    }
  ],
  "position" : [
    {
      "position_company": "Company Name",
      "position_title": "Engineer",
      "position_start_date": "2017-01-01T00:00:00.000Z",
      "position_end_date": "2019-01-01T00:00:00.000Z",
      "position_iscurrent": true
    }
  ]
}

400

bad input parameter

Search candidates
By passing in the appropriate options, you can search for available candidates in the system

Query parameters

keyword (optional)
Query Parameter — pass an optional keyword string for looking up candidates
project_id (optional)
Query Parameter — project id of candidates
page (optional)
Query Parameter — number of records to skip for pagination format: int
per_page (optional)
Query Parameter — maximum number of records to return format: int

Responses

200

Search results matching criteria
[
   {
      "id":"fu67c6fba4zab237.32939999",
      "link":"https://app.hiretual.com/talentprofile/fu67c6fba4zab237.32939999"
   },
   {
      "id":"9c783b6f-0938-4d8a-90e4-349aa253ff45",
      "link":"https://app.hiretual.com/talentprofile/9c783b6f-0938-4d8a-90e4-349aa253ff45"
   }
]

400

bad input parameter

Create candiate from resume

Path parameters

resume (required)
Path Parameter — resume file (pdf,doc,docx) format: binary

Request body

Body Parameter — Candidate Multipart Form Data Body Parameters
Content-Type: multipart/form-data

Responses

201

New candidate created
{
  "id": "8j36a294ea8965fd95.1367853420"
}

400

bad input parameter

HiringProcesses

Get all hiring processes

Responses

200

Search results matching criteria
[{
  "id" : 1,
  "hiringprocess_id" : "hp90ac786de08bdb7.33356876",
  "hiringprocess_name" : "Default Hiring Process",
  "hiringprocess_status" : 0,
  "hiringprocess_create_date" : "2018-04-01T00:00:00.000Z",
  "hiringprocess_user_id" : "78d76727-b476-4d09-bab9-4348f756e489",
  "hiringprocess_update_date" : "2018-04-01T00:00:00.000Z",
  "hiringprocess_team_id" : "team45ac678be90bdb7.33326876",
  "hiringprocess_detail" : [{
    "stages" : [
      {
        "stageStatus" : "active",
        "stageName" : "New",
        "isEditable" : false,
        "stageId" : 0
      }, {
        "stageStatus" : "active",
        "stageName" : "New",
        "isEditable" : false,
        "stageId" : 0
      }
    ],
    "categoryName" : "Sourcing",
    "categoryId" : 0
  }, {
    "stages" : [
      {
        "stageStatus" : "active",
        "stageName" : "New",
        "isEditable" : false,
        "stageId" : 0
      }, {
        "stageStatus" : "active",
        "stageName" : "New",
        "isEditable" : false,
        "stageId" : 0
      }
    ],
    "categoryName" : "Sourcing",
    "categoryId" : 0
  }]
}, {
  "id" : 2,
  "hiringprocess_id" : "hp34sd456de12byb7.33902276",
  "hiringprocess_name" : "Sample Hiring Process",
  "hiringprocess_status" : 0,
  "hiringprocess_create_date" : "2018-04-01T00:00:00.000Z",
  "hiringprocess_user_id" : "78d76727-b476-4d09-bab9-4348f756e489",
  "hiringprocess_update_date" : "2018-04-01T00:00:00.000Z",
  "hiringprocess_team_id" : "team45ac678be90bdb7.33326876",
  "hiringprocess_detail" : [{
    "stages" : [
      {
        "stageStatus" : "active",
        "stageName" : "New",
        "isEditable" : false,
        "stageId" : 0
      }, {
        "stageStatus" : "active",
        "stageName" : "New",
        "isEditable" : false,
        "stageId" : 0
      }
    ],
    "categoryName" : "Sourcing",
    "categoryId" : 0
  }, {
    "stages" : [
      {
        "stageStatus" : "active",
        "stageName" : "New",
        "isEditable" : false,
        "stageId" : 0
      }, {
        "stageStatus" : "active",
        "stageName" : "New",
        "isEditable" : false,
        "stageId" : 0
      }
    ],
    "categoryName" : "Sourcing",
    "categoryId" : 0
  }]
}]

400

bad input parameter

Get hiring processes by id

Path parameters

id (required)
Path Parameter — hiring processes id

Responses

200

Hiring process information
{
      "id" : 1,
      "hiringprocess_id" : "hp90ac786de08bdb7.33356876",
      "hiringprocess_name" : "Default Hiring Process",
      "hiringprocess_status" : 0,
      "hiringprocess_create_date" : "2018-04-01T00:00:00.000Z",
      "hiringprocess_user_id" : "78d76727-b476-4d09-bab9-4348f756e489",
      "hiringprocess_update_date" : "2018-04-01T00:00:00.000Z",
      "hiringprocess_team_id" : "team45ac678be90bdb7.33326876",
      "hiringprocess_detail" : [{
      "stages" : [
      {
      "stageStatus" : "active",
      "stageName" : "New",
      "isEditable" : false,
      "stageId" : 0
      }, {
      "stageStatus" : "active",
      "stageName" : "New",
      "isEditable" : false,
      "stageId" : 0
      }
      ],
      "categoryName" : "Sourcing",
      "categoryId" : 0
      }, {
      "stages" : [
      {
      "stageStatus" : "active",
      "stageName" : "New",
      "isEditable" : false,
      "stageId" : 0
      }, {
      "stageStatus" : "active",
      "stageName" : "New",
      "isEditable" : false,
      "stageId" : 0
      }
      ],
      "categoryName" : "Sourcing",
      "categoryId" : 0
      }]
      }

400

bad input parameter

Projects

Create a new project

Request body

Body Parameter — Project JSON Body Parameters
Content-Type: application/json
{
  "name": "Sample Project",
  "description": "This is a new sample project",
  "hiring_process_id": "hp5ac566d953ac4d1.15589506"
}

Responses

201

Project information
{
  "project_id": 871110,
  "project_name": "Sample Project",
  "project_description": "This is a new sample project",
  "project_hiring_process_id": "hp5ac566d953ac4d1.15589506",
  "project_status": "Active",
  "project_create_date": "2019-08-28T23:09:57.000Z",
  "project_update_date": "2019-08-28T23:09:57.000Z",
  "creator_id": "696576611c59eb77.99458934",
  "hiring_members": "Hiring members",
  "stage_details": "Stage details sample"
}

400

invalid input, object invalid

Delete project by project id

Path parameters

id (required)
Path Parameter — project id

Responses

200

Project deleted

400

bad input parameter

Get project by project id

Path parameters

id (required)
Path Parameter — project id

Responses

200

Project information
{
  "project_id": 871110,
  "project_team_id": "team45ac678be90bdb7.33326876",
  "project_user_id": "696576611c59eb77.99458934",
  "project_name": "Sample Project",
  "project_description": "This is a new sample project",
  "project_hiring_process_id": "hp90ac786de08bdb7.33356876",
  "project_status": "PROJECT_STATUS_NORMAL",
  "project_create_date": "2019-09-04T23:37:15.000Z",
  "project_update_date": "2019-10-09T00:31:31.000Z",
  "project_creator_id": "696576611c59eb77.99458934",
  "project_hiring_members": "Hiring members",
  "project_stage_details": "Stage details sample",
  "project_hiring_process":{
    "id": 1,
    "hiringprocess_id": "hp90ac786de08bdb7.33356876",
    "hiringprocess_team_id": "team45ac678be90bdb7.33326876",
    "hiringprocess_user_id": "78d76727-b476-4d09-bab9-4348f756e489",
    "hiringprocess_name": "Default Hiring Process",
    "hiringprocess_status": 0,
    "hiringprocess_create_date": "2018-04-02T02:26:38.000Z",
    "hiringprocess_update_date": "2018-04-02T02:26:38.000Z",
    "hiringprocess_detail":[{"stages":[{"stage_id": 0, "stage_name": "New", "stage_status": "active",…]
  }
}

400

bad input parameter

Search projects
By passing in the appropriate options, you can search for available projects in the system

Query parameters

project_name (optional)
Query Parameter — pass an optional project name string for looking up projects
page (optional)
Query Parameter — number of records to skip for pagination format: int
per_page (optional)
Query Parameter — maximum number of records to return format: int

Responses

200

Search results matching criteria
{
  "total": 127,
  "result": [
    {
      "project_id": 871110,
      "project_name": "Sample Project",
      "project_description": "This is a new sample project",
      "project_hiring_process_id": "hp90ac786de08bdb7.33356876",
      "project_status": "Active",
      "project_create_date": "2019-08-28T23:09:57.000Z",
      "project_update_date": "2019-08-28T23:09:57.000Z",
      "creator_id": "696576611c59eb77.99458934",
      "hiring_members": "Hiring members",
      "stage_details": "Stage details sample"
    }
  ]
}

400

bad input parameter

Update project information by project id

Path parameters

id (required)
Path Parameter — project id

Request body

Body Parameter — Project JSON Body Parameters
Content-Type: application/json
{
  "name": "Sample Project",
  "description": "This is a new sample project",
  "hiring_process_id": "hp90ac786de08bdb7.33356876"
}

Responses

200

Project information updated
{
  "project_id": 871110,
  "project_team_id": "team45ac678be90bdb7.33326876",
  "project_user_id": "696576611c59eb77.99458934",
  "project_name": "Sample Project",
  "project_description": "This is a new sample project",
  "project_hiring_process_id": "hp90ac786de08bdb7.33356876",
  "project_status": "PROJECT_STATUS_NORMAL",
  "project_create_date": "2019-09-04T23:37:15.000Z",
  "project_update_date": "2019-10-09T00:31:31.000Z",
  "project_creator_id": "696576611c59eb77.99458934",
  "project_hiring_members": "Hiring members",
  "project_stage_details": "Stage details sample",
  "project_hiring_process":{
    "id": 1,
    "hiringprocess_id": "hp90ac786de08bdb7.33356876",
    "hiringprocess_team_id": "team45ac678be90bdb7.33326876",
    "hiringprocess_user_id": "78d76727-b476-4d09-bab9-4348f756e489",
    "hiringprocess_name": "Default Hiring Process",
    "hiringprocess_status": 0,
    "hiringprocess_create_date": "2018-04-02T02:26:38.000Z",
    "hiringprocess_update_date": "2018-04-02T02:26:38.000Z",
    "hiringprocess_detail":[{"stages":[{"stage_id": 0, "stage_name": "New", "stage_status": "active",…]
  }
}

400

bad input parameter

Copyright © Hiretual 2019. All Rights Reserved