ApplicantStack API Explorer Utility

This webpage allows for testing of various ApplicantStack API methods similar to what you might find on a Swagger API Platform webpage. The current iteration of the ApplicantStack API does not have a CORS implementation for security purposes as API Access Tokens are sent as part of the header in API calls, so a custom PHP API wrapper was developed to be able to send API calls to ApplicantStack via a web browser.

The utility is divided into three major sections: Jobs, Candidates, and Hires. After you enter your settings below, use the navigation menu to view the various pages and make test calls. When a call is made, an example cURL request will be provided that can then be used externally such as through a command prompt/terminal cURL connection.

Instructions:

  1. Here in the Settings page, enter in your ApplicantStack domain. This is the first part of the ApplicantStack URL. So if your ApplicantStack site is test.applicantstack.com, then you would enter test.
  2. Enter your ApplicantStack API Token. This is found in your account settings (you must be an Administrator to see your API token).
  3. Use the various pages on this webpage to make API Calls and see data returned, create new records, or update existing information in your account.

If you're looking for information on how to implement and use the API, you can check out the official documentation found on the ApplicantStack Knowledge Base website.

Please enter your account details to make API calls. The Publisher Name is required if you will be making POST or PUT calls, but not for GET calls.

GET Jobs

The Jobs API method will return an array of jobs from the specified ApplicantStack account. It's limited to 100 records per "page", meaning if the account has more than 100 jobs, you will have to loop through each page to see all jobs. Using this API Method, you can retrieve the Job Serial, which is the unique identifier for jobs in ApplicantStack, and can subsequently be used to make individual calls to the Job API method to obtain all of the specifics about that single job.

Note: The actual data fields returned may be different based on your individual account configuration.

{
    "Method Result": "Success",
    "Page": 1,
    "NumPages": 14,
    "TotalCount": 1400,
    "Jobs": [
        {
            "Job ID": "1234",
            "Job Serial": "a2pnj8sscttx",
            "Job Name": "Account Manager",
            "Stage": "Filled",
            "Stage Type": "Filled",
            "Location": "Miami, FL",
            "Department": "Customer Success",
            "Job Category": "Management",
            "Job Type": "Exempt (salaried)",
            "Campaign Start Date": "07/04/2021",
            "Salary Range": "80K - 95K",
            "Create Date": "06/18/2021 02:44 PM",
            "Create Date Timestamp": 1624041851,
            "Last Modified Date": "09/15/2021 11:30 AM",
            "Last Modified Date Timestamp": 1631719803
        },
        {
            "Job ID": "2345",
            "Job Serial": "a2pnj8s6nfp3",
            "Job Name": "Support Technician",
            "Stage": "Open",
            "Stage Type": "Open",
            "Location": "Chicago, IL",
            "Department": "Customer Success",
            "Job Category": "Employee",
            "Job Type": "Exempt (salaried)",
            "Campaign Start Date": "08/11/2021",
            "Salary Range": "40K - 60K",
            "Create Date": "07/26/2021 05:12 PM",
            "Create Date Timestamp": 1627319520,
            "Last Modified Date": "09/21/2021 9:22 AM",
            "Last Modified Date Timestamp": 1632216120
        }
    ]
}

To test this endpoint out, click the button below (after you have entered your API Settings in). This API call will return only 100 records at a time, so if you'd like to see the next set of data, enter in the page number in the box below. This field is optional.

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

GET Job

The Job API method will return data of the specified Job. This call would typically be used in tandem with the Jobs API method after you have the Job Serial (unique system identifier), as the Job Serial is a required parameter for this API call.

In the below example data, you'll see that most of the data is the same as what's returned in the Jobs call, however, one notable difference is the inclusion of the Job Listing (both a parsed and a Raw HTML version), serial ID of Questionnaires attached to the job, and serial ID of scoring rules attached to the job.

Note: The actual data fields returned may be different based on your individual account configuration.

{
    "Method Result": "Success",
    "Job ID": "SAMP-1001",
    "Job Serial": "a2wlaydyjrmg",
    "Job Name": "Accounting Manager (Sample)",
    "Stage": "Open",
    "Stage Type": "Open",
    "Job Boards": [
        "applicantstack"
    ],
    "Job Listing": "Use your outstanding accounting skills to manage the close process for the Company. Join a talented team of financial professionals and work directly under the supervision of the Controller. This Accounting Manager will also perform a variety of other accounting activities (listed below) in accordance with Generally Accepted Accounting Principles (GAAP) and company policies and procedures.\nEssential Functions\n\t\tTake the lead in the month-end and year-end close, including creating and entering journal entries and performing general ledger account analysis\n\t\tManage indirect cost reports and submissions\n\t\tPrepare monthly financial reports for senior operations personnel\n\t\tOversee and prepare month-end customer invoices\n\t\tPrepare Balance Sheet Reconciliations\n\t\tFixed Asset Accounting\n\t\tAssist with the year-end financial audit\n\t\tAssist with development of the annual budget\n\t\tManage state filing and registration process\n\t\tSales and Property Tax Return preparation\n\t\tPerform special projects as assigned by Controller\n\t\tOccasional travel required (<25%)\nRequired Experience\n\t\tWorking knowledge of US GAAP required\n\t\tKnowledge of the Federal Acquisition Regulations (FAR) preferred, but not required\n\t\tKnowledge of Excel and Word experience required\n\t\tExperience with a major ERP Financial Management system required, experience with Costpoint preferred\n\t\tAbility to collaborate professionally with operational department and external vendors\n\t\tMust be a problem solver\n\t\tExperience with Government and Commercial Contracts required\n\t\tExperience in a Job Cost Accounting environment strongly preferred\n\t\tRevenue recognition\nEducation or Equivalent Experience\n\t\tBachelor's degree in Accounting required\n\t\tMinimum 8-15 years general ledger accounting experience\n\t\tCPA preferred",
    "Job Listing Html": "Use your outstanding accounting skills to manage the close process for the Company. Join a talented team of financial professionals and work directly under the supervision of the Controller. This Accounting Manager will also perform a variety of other accounting activities (listed below) in accordance with Generally Accepted Accounting Principles (GAAP) and company policies and procedures.<br />\r\n<br />\r\n<strong>Essential Functions</strong><br />\r\n<ul>\r\n\t<li>\r\n\t\tTake the lead in the month-end and year-end close, including creating and entering journal entries and performing general ledger account analysis</li>\r\n\t<li>\r\n\t\tManage indirect cost reports and submissions</li>\r\n\t<li>\r\n\t\tPrepare monthly financial reports for senior operations personnel</li>\r\n\t<li>\r\n\t\tOversee and prepare month-end customer invoices</li>\r\n\t<li>\r\n\t\tPrepare Balance Sheet Reconciliations</li>\r\n\t<li>\r\n\t\tFixed Asset Accounting</li>\r\n\t<li>\r\n\t\tAssist with the year-end financial audit</li>\r\n\t<li>\r\n\t\tAssist with development of the annual budget</li>\r\n\t<li>\r\n\t\tManage state filing and registration process</li>\r\n\t<li>\r\n\t\tSales and Property Tax Return preparation</li>\r\n\t<li>\r\n\t\tPerform special projects as assigned by Controller</li>\r\n\t<li>\r\n\t\tOccasional travel required (&lt;25%)</li>\r\n</ul>\r\n<strong>Required Experience</strong><br />\r\n<ul>\r\n\t<li>\r\n\t\tWorking knowledge of US GAAP required</li>\r\n\t<li>\r\n\t\tKnowledge of the Federal Acquisition Regulations (FAR) preferred, but not required</li>\r\n\t<li>\r\n\t\tKnowledge of Excel and Word experience required</li>\r\n\t<li>\r\n\t\tExperience with a major ERP Financial Management system required, experience with Costpoint preferred</li>\r\n\t<li>\r\n\t\tAbility to collaborate professionally with operational department and external vendors</li>\r\n\t<li>\r\n\t\tMust be a problem solver</li>\r\n\t<li>\r\n\t\tExperience with Government and Commercial Contracts required</li>\r\n\t<li>\r\n\t\tExperience in a Job Cost Accounting environment strongly preferred</li>\r\n\t<li>\r\n\t\tRevenue recognition</li>\r\n</ul>\r\n<strong>Education or Equivalent Experience</strong><br />\r\n<ul>\r\n\t<li>\r\n\t\tBachelor&#39;s degree in Accounting required</li>\r\n\t<li>\r\n\t\tMinimum 8-15 years general ledger accounting experience</li>\r\n\t<li>\r\n\t\tCPA preferred</li>\r\n</ul>\r\n",
    "Questionnaire Serials": [
        "a7wlaydoisim"
    ],
    "Scoring Serials": [
        "a9wlayd1nq13"
    ],
    "Location": "Atlanta, GA",
    "Department": "Finance",
    "Job Category": "Middle Management",
    "Job Type": "Exempt (salaried)",
    "Campaign Start Date": "07/04/2021",
    "Salary Range": "80K - 95K",
    "Note": "",
    "Create Date": "07/05/2021 09:50 AM",
    "Create Date Timestamp": 1625478600,
    "Last Modified Date": "07/05/2021 09:50 AM",
    "Last Modified Date Timestamp": 1625478600
}

To test this endpoint out, click the button below (after you have entered your API Settings in). For this API call you'll need to specify the Job Serial ID, which you can enter in the box below.

Please enter a Job Serial ID

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

PUT Job

The PUT Job API method allows for updating a specific job and related information about said job. This call would typically be used in tandem with the Jobs API method after you have the Job Serial (unique system identifier), as the Job Serial is a required parameter for this API call.

Note: When making a PUT call, if you wish to update the Job Name, pass the field as "Name" instead of "Job Name". In addition, some fields cannot be changed through the API. These fields will not show in the list below after clicking Get Fields, though they will show in GET calls: Job Serial, Job Listing, Job Listing Html, Job Boards, Note, Create Date, Create Date Timestamp, Last Modified Date, Last Modified Date Timestamp, Questionnaire Serials, Scoring Serials, and Stage Type.

To test this endpoint out, first enter the Job Serial that you'd like to update, and click the "get fields" button below (after you have entered your API Settings in). Once you've done that, new fields will appear populated with the current data for that job. Check the box next to the fields you'd like to update and replace the text in the corresponding field you wish to update for the specified job. If you leave the field blank it will send an empty string, deleting the current value In ApplicantStack. Click the "try" button to test out your updates.

Please enter a Job Serial ID

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

GET Candidates

The Candidates API method will return an array of candidates from the specified ApplicantStack account. It's limited to 100 records per "page", meaning if the account has more than 100 candidates, you will have to loop through each page to see all candidates. Using this API Method, you can retrieve the Candidate Serial, which is the unique identifier for candidates in ApplicantStack, and can subsequently be used to make individual calls to the Candidate API method to obtain all of the specifics about that single candidate.

Note: The actual data fields returned may be different based on your individual account configuration.

{
    "Method Result": "Success",
    "Page": 1,
    "NumPages": 1,
    "TotalCount": 12,
    "Candidates": [
        {
            "Candidate Serial": "a4wlaydhglzg",
            "Job Serial": "a2wlaydyjrmg",
            "Job Name": "Accounting Manager",
            "First Name": "John",
            "Last Name": "Doe",
            "Address 1": "1234 Main Street",
            "Address 2": "",
            "City": "Morrisville",
            "State": "NC",
            "Zip": "27560",
            "Phone": "919-555-4655",
            "Email": "email@email.com",
            "Source": "Indeed",
            "Rating": "Unqualified",
            "Disposition": "Insufficient Education",
            "Referred By": "",
            "Stage": "New",
            "Stage Type": "New",
            "Score": "KO",
            "Create Date": "02/01/2021 09:50 AM",
            "Create Date Timestamp": 1612198228
        },
        {
            "Candidate Serial": "a4wlaydgrz7a",
            "Job Serial": "a2wlaydyjrmg",
            "Job Name": "Accounting Manager",
            "First Name": "Jane",
            "Last Name": "Doe",
            "Address 1": "5678 State Street)",
            "Address 2": "",
            "City": "Cary",
            "State": "NC",
            "Zip": "27513",
            "Phone": "(919) 555-1142",
            "Email": "email2@email.com",
            "Source": "Facebook",
            "Rating": "Potential",
            "Disposition": "",
            "Referred By": "",
            "Stage": "New",
            "Stage Type": "New",
            "Score": "20",
            "Create Date": "02/01/2021 09:50 AM",
            "Create Date Timestamp": 1612198229
        }
    ]
}

To test this endpoint out, click the button below (after you have entered your API Settings in). This API call will return only 100 records at a time, so if you'd like to see the next set of data, enter in the page number in the box below. This field is optional.

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

GET Candidate

The Candidate API method will return data of the specified Candidate. This call would typically be used in tandem with the Candidates API method after you have the Candidate Serial (unique system identifier), as the Candidate Serial is a required parameter for this API call.

In the below example data, you'll see that most of the data is the same as what's returned in the Candidates call, however, some notable differences are the inclusion of the cover letter (if applicable), notes entered on the candidate's profile, files/attachments uploaded to the candidate's profile (with direct links to download them), and questionnaire answers.

Note: The actual data fields returned may be different based on your individual account configuration.

{
    "Method Result": "Success",
    "Candidate Serial": "a4wlaydhglzg",
    "Job Serial": "a2wlaydyjrmg",
    "Job Name": "Accounting Manager",
    "First Name": "John",
    "Last Name": "Doe",
    "Address 1": "1234 Main Street",
    "Address 2": "",
    "City": "Morrisville",
    "State": "NC",
    "Zip": "27560",
    "Phone": "919-555-4655",
    "Email": "email@email.com",
    "Source": "Indeed",
    "Rating": "Unqualified",
    "Disposition": "Insufficient Education",
    "Referred By": "",
    "Stage": "New",
    "Stage Type": "New",
    "Score": "KO",
    "Create Date": "02/01/2021 09:50 AM",
    "Create Date Timestamp": 1612198228,
    "Cover Letter": "",
    "Notes": [],
    "Files": [
        {
            "name": "resume.doc",
            "url": "https://domain.applicantstack.com/x/attachment/a6wlaydw38wf?apikey=1234",
            "is_resume": 1,
            "apikey_expires": 1635314400
        }
    ],
    "Questionnaires": [
        {
            "Questionnaire Name": "Accounting Manager Questions",
            "Questionnaire Serial": "a7wlaydoisim",
            "Submit Date": "02/01/2021 09:50 AM",
            "Submit Date Timestamp": 1612198229,
            "Score": "KO",
            "Questions": [
                {
                    "Question": "Are you authorized to work in the United States for any employer?",
                    "Value": "Yes"
                },
                {
                    "Question": "Do you have a bachelors degree?",
                    "Value": "No"
                },
                {
                    "Question": "How many years experience do you have?",
                    "Value": "5+ Years"
                },
                {
                    "Question": "What minimum salary do you require?",
                    "Value": "75k"
                }
            ]
        }
    ]
}

To test this endpoint out, click the button below (after you have entered your API Settings in). For this API call you'll need to specify the Candidate Serial ID, which you can enter in the box below.

Please enter a Candidate Serial ID

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

PUT Candidate

The PUT Candidate API method allows for updating a specific candidate and related information about said candidate. This call would typically be used in tandem with the GET Candidates API method after you have the Candidate Serial (unique system identifier), as the Candidate Serial is a required parameter for this API call.

With the PUT Candidate API method, you can set the candidate's stage. You have the option of setting the stage either with the name of the stage, or the unique stage ID. This ID can be retrieved by navigating to the account configuration within ApplicantStack (specifically the Application Stages, found in the "Configure" tab), and clicking the pencil icon next to each stage. The ID of the stage will be the last part of the URL that loads. For example, if the url is https://example.applicantstack.com/stages/edit/e6prgoyj2a31, the ID of that stage is e6prgoyj2a31.

Note: Some fields cannot be changed through the API. These fields will not show in the list below after clicking Get Fields, though they will show in GET calls: Candidate Serial, Job Serial, Job Name, Stage Type, Score, Create Date, Create Date Timestamp, Cover Letter, Files, Questionnaires, and Notes.

To test this endpoint out, first enter the Candidate Serial that you'd like to update, and click the "get fields" button below (after you have entered your API Settings in). Once you've done that, new fields will appear populated with the current data for that candidate. Check the box next to the fields you'd like to update and replace the text in the corresponding field you wish to update for the specified candidate. If you leave the field blank it will send an empty string, deleting the current value In ApplicantStack. Click the "try" button to test out your updates.

Please enter a Candidate Serial ID

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

POST Candidate

The POST Candidate API method allows for creating a new candidate in the system. This call requires at minimum all required fields to be filled out. If optional fields are not filled out, warnings will be returned, but the call will still be successful. If required fields are missing, a candidate will not be created and an error message with a list of missing fields will be returned.

With the POST Candidate API method, you can set the candidate's stage. You have the option of setting the stage either with the name of the stage, or the unique stage ID. This ID can be retrieved by navigating to the account configuration within ApplicantStack (specifically the Application Stages, found in the "Configure" tab), and clicking the pencil icon next to each stage. The ID of the stage will be the last part of the URL that loads. For example, if the url is https://example.applicantstack.com/stages/edit/e6prgoyj2a31, the ID of that stage is e6prgoyj2a31.

Note: Some fields cannot be set through the API when creating a Candidate. These fields will not show in the list below after clicking Get Fields, though they will show in GET calls: Candidate Serial, Job Name, Stage Type, Score, Create Date, Create Date Timestamp, Cover Letter, Files, Questionnaires, and Notes.

To test this endpoint out, first click the "get fields" button below (after you have entered your API Settings in). Once you've done that, new fields will appear that you can fill out to create a new Candidate. Note, if the field is required, it will be indicated in the field. If you leave any given field blank, that value will not be sent. Note however that with required fields you must send a value or you will get an error. Click the "try" button to test out your POST call after you have filled out all applicable fields.

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

GET Hires

The Hires API method will return an array of hires from the specified ApplicantStack account. It's limited to 100 records per "page", meaning if the account has more than 100 hires, you will have to loop through each page to see all hires. Using this API Method, you can retrieve the Hire Serial, which is the unique identifier for hires in ApplicantStack, and can subsequently be used to make individual calls to the Hire API method to obtain all of the specifics about that single hire.

Note: The actual data fields returned may be different based on your individual account configuration.

{
    "Method Result": "Success",
    "Page": 1,
    "NumPages": 1,
    "TotalCount": 7,
    "Hires": [
        {
            "Hire Serial": "e2pkzoqt0fup",
            "First Name": "Maria",
            "Last Name": "Valdez",
            "Email": "fakeemail@fakeemail.com",
            "Address 1": "1234 Main Street",
            "Address 2": "",
            "City": "Raleigh",
            "State": "NC",
            "Zip": "27616",
            "Phone": "(518) 512-0275",
            "Start Date": "01/01/2018",
            "Job Name": "Account Manager",
            "Department": "Finance",
            "Location": "Raleigh, NC",
            "Job Category": "Middle Management",
            "Job Type": "Exempt (salaried)",
            "Pay Rate": "$65k/year",
            "test": "",
            "Stage": "Orientation",
            "Manager": "Hiring Manager Test",
            "Create Date": "07/12/2019 02:56 PM",
            "Last Modified Date": "11/12/2020 04:59 PM"
        },
        {
            "Hire Serial": "e2pkzoquyahz",
            "First Name": "Carter",
            "Last Name": "Roberts",
            "Email": "fakeemail@fakeemail.com",
            "Address 1": "5678 Main Street",
            "Address 2": "",
            "City": "Atlanta",
            "State": "GA",
            "Zip": "34599",
            "Phone": "924-134-7845",
            "Start Date": "01/01/2018",
            "Job Name": "Accounting Manager",
            "Department": "Finance",
            "Location": "Atlanta, GA",
            "Job Category": "Middle Management",
            "Job Type": "Exempt (salaried)",
            "Pay Rate": "$75k/year",
            "test": "",
            "Stage": "Orientation",
            "Manager": "Recruiter Test",
            "Create Date": "07/12/2019 02:56 PM",
            "Last Modified Date": "06/05/2020 08:25 AM"
        }
    ]
}

To test this endpoint out, click the button below (after you have entered your API Settings in). This API call will return only 100 records at a time, so if you'd like to see the next set of data, enter in the page number in the box below. This field is optional.

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

GET Hire

The Hire API method will return data of the specified Hire. This call would typically be used in tandem with the Hires API method after you have the Hire Serial (unique system identifier), as the Hire Serial is a required parameter for this API call.

In the below example data, you'll see that most of the data is the same as what's returned in the Hires call, however, some notable differences are the inclusion of questionnaire answers and form submissions.

Note: The actual data fields returned may be different based on your individual account configuration.

{
    "Method Result": "Success",
    "Hire Serial": "e2pkzoqt0fup",
    "Candidate Serial": "",
    "First Name": "Maria",
    "Last Name": "Valdez",
    "Email": "fakeemail@fakeemail.com",
    "Address 1": "1234 Main Street",
    "Address 2": "",
    "City": "Raleigh",
    "State": "NC",
    "Zip": "27616",
    "Phone": "(518) 512-0275",
    "Start Date": "01/01/2018",
    "Job Name": "Account Manager",
    "Department": "Finance",
    "Location": "Raleigh, NC",
    "Job Category": "Middle Management",
    "Job Type": "Exempt (salaried)",
    "Pay Rate": "$65k/year",
    "Stage": "Orientation",
    "Manager": "Hiring Manager User",
    "Create Date": "07/12/2019 02:56 PM",
    "Last Modified Date": "11/12/2020 04:59 PM",
    "Questionnaires": [
        {
            "Questionnaire Name": "Uniform Sizing Worksheet (Sample)",
            "Questionnaire Serial": "e4pkzoqratf5",
            "Submit Date": "11/12/2020 04:58 PM",
            "User": "Hiring Manager User",
            "Questions": [
                {
                    "Question": "Preferred polo color",
                    "Value": "Red"
                },
                {
                    "Question": "Your shirt size",
                    "Value": "test"
                },
                {
                    "Question": "Your pant size",
                    "Value": "test"
                }
            ]
        }
    ],
    "Forms": [
        {
            "Form Name": "I-9 with Employer Sections",
            "Form Serial": "e4pkzoq36xu6",
            "Submit Date": "11/12/2020 04:57 PM",
            "User": "failprooftest",
            "Questions": [
                {
                    "Question": "Last Name Family Name",
                    "Value": "Valdez"
                },
                {
                    "Question": "First Name Given Name",
                    "Value": "Maria"
                },
                {
                    "Question": "Middle Initial",
                    "Value": ""
                },
                {
                    "Question": "Other Last Names Used if any",
                    "Value": ""
                },
                {
                    "Question": "Address Street Number and Name",
                    "Value": "254 Evergreen St"
                },
                {
                    "Question": "Apt Number",
                    "Value": ""
                },
                {
                    "Question": "City or Town",
                    "Value": "Raleigh"
                },
                {
                    "Question": "State",
                    "Value": "NC"
                },
                {
                    "Question": "ZIP Code",
                    "Value": "27616"
                },
                {
                    "Question": "Date of Birth mmddyyyy",
                    "Value": "11/12/2020"
                },
                {
                    "Question": "SSN1",
                    "Value": "123"
                },
                {
                    "Question": "SSN2",
                    "Value": "45"
                },
                {
                    "Question": "SSN3",
                    "Value": "6789"
                },
                {
                    "Question": "Employees Email Address",
                    "Value": "fakeemail@fakeemail.com"
                },
                {
                    "Question": "Employees Telephone Number",
                    "Value": "(518) 512-0275"
                },
                {
                    "Question": "Alien Registration NumberUSCIS Number 1",
                    "Value": ""
                },
                {
                    "Question": "Alien Registration NumberUSCIS Number 2",
                    "Value": ""
                },
                {
                    "Question": "1 Alien Registration NumberUSCIS Number",
                    "Value": ""
                },
                {
                    "Question": "2 Form I94 Admission Number",
                    "Value": ""
                },
                {
                    "Question": "3 Foreign Passport Number",
                    "Value": ""
                },
                {
                    "Question": "Country of Issuance",
                    "Value": ""
                },
                {
                    "Question": "Signature of Employee",
                    "Value": "asd;lfjaksl;djf;klajsdk;fl"
                },
                {
                    "Question": "Todays Date mmddyyyy",
                    "Value": "11/12/2020"
                },
                {
                    "Question": "Prep or Tran",
                    "Value": "I did not use"
                }
            ]
        }
    ]
}

To test this endpoint out, click the button below (after you have entered your API Settings in). For this API call you'll need to specify the Hire Serial ID, which you can enter in the box below.

Please enter a Hire Serial ID

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

PUT Hire

The PUT Hire API method allows for updating a specific hire and related information about said hire. This call would typically be used in tandem with the Hires API method after you have the Hire Serial (unique system identifier), as the Hire Serial is a required parameter for this API call.

With the PUT Hire API method, you can set the hire's stage. However, unlike in ApplicantStack Recruit, to set the stage you can only do so using the unique stage ID - you cannot use the stage name. This ID can be retrieved by navigating to the account configuration within ApplicantStack (specifically the Hire Workflow Stages, found in the "Configure" tab), and clicking the pencil icon next to each stage. The ID of the stage will be the last part of the URL that loads. For example, if the url is https://example.applicantstack.com/o/stages/edit/e6prgoyj2a31, the ID of that stage is e6prgoyj2a31.

Note: Some fields cannot be changed through the API. These fields will not show in the list below after clicking Get Fields, though they will show in GET calls: Hire Serial, Candidate Serial, Manager, Create Date, Last Modified Date, Questionnaires, and Forms.

To test this endpoint out, first enter the Hire Serial that you'd like to update, and click the "get fields" button below (after you have entered your API Settings in). Once you've done that, new fields will appear populated with the current data for that hire. Check the box next to the fields you'd like to update and replace the text in the corresponding field you wish to update for the specified hire. If you leave the field blank it will send an empty string, deleting the current value In ApplicantStack. Click the "try" button to test out your updates.

Please enter a Hire Serial ID

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error

POST Hire

The POST Hire API method allows for creating a new hire in the system. This call requires at minimum all required fields to be filled out. If optional fields are not filled out, warnings will be returned, but the call will still be successful. If required fields are missing, a hire will not be created and an error message with a list of missing fields will be returned.

With the POST Hire API method, you can set the hire's stage. However, unlike in ApplicantStack Recruit, to set the stage you can only do so using the unique stage ID - you cannot use the stage name. This ID can be retrieved by navigating to the account configuration within ApplicantStack (specifically the Hire Workflow Stages, found in the "Configure" tab), and clicking the pencil icon next to each stage. The ID of the stage will be the last part of the URL that loads. For example, if the URL is https://example.applicantstack.com/o/stages/edit/e6prgoyj2a31, the ID of that stage is e6prgoyj2a31.

Similar to setting the hire's stage, you can also set the hire's workflow. This configures which workflow they will follow when advancing through stages in the system. You cannot use the workflow name to set the workflow, but you can use the workflow ID. This ID can be retrieved by navigating to the account configuration within ApplicantStack (specifically the Hire Workflow, found in the "Configure" tab) and clicking the pencil icon next to the workflow name. The ID of the stage will be the last part of the URL that loads. For example, if the URL is https://example.applicantstack.com/o/workflow/edit/ekpkzoqdjxf4, the ID of that workflow is ekpkzoqdjxf4. If you do not specify a specific workflow ID, the hire will be assigned to the default workflow configured on the account.

Note: Some fields cannot be set through the API when creating a Hire. These fields will not show in the list below after clicking Get Fields, though they will show in GET calls: Hire Serial, Candidate Serial, Create Date, Last Modified Date, Questionnaires, and Forms.

To test this endpoint out, first click the "get fields" button below (after you have entered your API Settings in). Once you've done that, new fields will appear that you can fill out to create a new Hire. Note, if the field is required, it will be indicated in the field. If you leave any given field blank, that value will not be sent. Note however that with required fields you must send a value or you will get an error. Click the "try" button to test out your POST call after you have filled out all applicable fields.

Response Messages

200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error