OneClick Employer API v2.0.1



Welcome

Welcome to the JobTarget OneClick API Developer Guide. Within these pages, you will have access to a number functions to allow you to integrate your systems with the OneClick systems. The end result of your efforts will be a simplified, streamlined experience for our mutual customers.

The first thing you need from JobTarget is a p_token. This is your system’s ticket to interact with JobTarget’s OneClick systems. You will use this to authenticate your organization, as you communicate through our API. If you do not have this, please reach out to your JobTarget contact.

If you do have your p_token, then please proceed to the following pages. Also, we have created a Implementation Guide to help you think about how you might want to use these integration points in your products.

Get User Token - /api/employer/auth/gettoken

Authenticate a user with the OneClick system and get a token that can be used to perform other functions related to or on behalf of that particular user.

INPUT OUTPUT
p_token - the partner token/key that must be passed to authenticate API access
email - email address of the user
uid - unique identifier for given user (optional)

NOTE: - uid is only required if your p_token requires a uid to be sent along with the user's email
status - 0 indicates success. Any other result indicates an issue
message - message related to the status
token - authenticated user token. This value must be passed in all subsequent calls to the API as it may relate to this user
user_id – OneClick’s unique ID of the authenticated user
first_name – first name of the authenticated user
last_name – last name of the authenticated user
title – job title of the authenticated user
email – email address of the authenticated user
user_type – the user role as defined in OneClick for the authenticated user

Create a Company - /api/employer/company/create

Create a new company in OneClick

INPUT OUTPUT
p_token - the partner token/key that must be passed to authenticate API access
name - this is the name of the company you are creating
external_company_id - the ID of the company in your ATS system (number)
billing_street_address - The billing address
billing_city - The billing city
billing_state - The ISO code representing the state. (Find lookup in Reference section)
billing_zip - The zip code
billing_country - The ISO code representing the country. (Find lookup in Reference section)

Optional
industry_id - the OneClick ID representing the closest industry for the new company. (Find lookup in Reference section)
status - 0 indicates success. Anything else indicates an issue
message - message related to the status
company_id – JobTarget’s unique ID for the new company
company_name – this is the name for the new company
create_date – the date the company was created

Error Codes
1 = There was an error in processing your request.
2 = There was an error in processing your request - invalid token.
6 = there was an error in processing your request - name cannot be blank.
7 = There was an error in processing your request - channel_site_id not setup correctly (please notify JobTarget).
8 = There was an error in processing your request - external_company_id is required.
9 = There was an error in processing your request - external_company_id must be unique.

Get Company Jobs - /api/employer/company/jobs

Admin onlyList of jobs associated with the company, based upon a specific time duration.

INPUT OUTPUT
token - the user token that must be passed to authenicate API access
days - how far back (in days) you wish to retrieve jobs (based upon last updated date)
status - 0 indicates success. Anything else indicates an issue
message - message related to the status
job_id – JobTarget’s unique Job ID
requisition_name – this is the unique ID from your system for the client’s job. Usually a requisition number or unique job reference name
position – this is the job title
division_id – this is the ID of the OneClick division folder the job belongs to
division_name – this is the name of the OneClick division folder the job belongs to
updated_date – date/time stamp of when the job was last updated in OneClick
created_date – date/time stamp of when job was created in OneClick
job_manage_url – the URL to use to Single Sign On (SSO) the user into OneClick and land them on this job to manage it
job_post_url – the URL to use to SSO the user into OneClick and land them on the job to post it to job sites

Get Company Divisions - /api/employer/company/divisions

Admin onlyRetrieve list of all divisions associated with this company.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue
message - message related to the Status.
division_id – the unique ID number for that division in OneClick
name – the name for that division in OneClick

Get Company Users - /api/employer/company/users

Admin onlyRetrieve list of all users associated with this company.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
user_id – OneClick’s unique ID for this user
first_name – the user’s first name
last_name – the user’s last name
email – the user’s email address
user_type – the user role as defined in OneClick (Admin or Recruiter)

Get Companies Via p_token - /api/employer/company/getcompaniesviaptoken

Admin onlyRetrieve list of all companies associated with this p_token.

INPUT OUTPUT
p_token - the p_token that is used to authenticate API access
external_company_id - external company id of company you want returned (optional)
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status.
company_id – the unique ID number for that company in OneClick
name – the name for that companu in OneClick
external_company_id – the external company id (usually your ATS id for that company)
billing_street_address - The billing address
billing_city - The billing city
billing_state - The billing state
billing_zip - The zip code
billing_country - The billing country
is_active - See if a company or user is active/inactive in our system

Get Companies Jobs p_token - /api/employer/company/getcompanyjobsviaptoken

Admin onlyRetrieve list of all company jobs associated with this p_token and company_id.

INPUT OUTPUT
p_token - the p_token that is used to authenticate API access
company_id - the id of the company whose jobs you wish to retriece
days - how far back (in days) you wish to retrieve jobs (based upon last updated date)
status - 0 indicates success. Anything else indicates an issue
message - message related to the status
job_id – JobTarget’s unique Job ID
requisition_name – this is the unique ID from your system for the client’s job. Usually a requisition number or unique job reference name
position – this is the job title
division_id – this is the ID of the OneClick division folder the job belongs to
division_name – this is the name of the OneClick division folder the job belongs to
updated_date – date/time stamp of when the job was last updated in OneClick
created_date – date/time stamp of when job was created in OneClick
job_manage_url – the URL to use to Single Sign On (SSO) the user into OneClick and land them on this job to manage it
job_post_url – the URL to use to SSO the user into OneClick and land them on the job to post it to job sites

Applicant Data - /api/employer/company/applicantdata

Submit interview and hire data to OneClick.

INPUT OUTPUT
p_token - the partner token/key that must be passed to authenticate API access

job_id - optional
posting_id - optional
profile_id - optional
hash_id - optional

The combination of job_id and posting_id OR combination of profile_id and hash_id are required.

created_date - date when the interview or hire occurred (optional)
first_name - required
last_name - required
email - required
status_id - options are '1=interview', '2=hire' and '3=application' (required)
status - 0 indicates success. Anything else indicates an issue
message - message related to the status

Create User - /api/employer/user/create

Admin onlyCreate a new user in OneClick.

INPUT OUTPUT
p_token - the partner token that must be passed to authenticate API access
first_name - first name of the user to be created in OneClick
last_name - last name of the user to be created in OneClick
title - title of the user to be created in OneClick
email - email of the user to be created in OneClick
is_admin - if 1, we will setup the user as an Administrator for their Company in OneClick. If 0, they will be setup as a Recruiter user type without administrative privileges
company_id - the unique company ID in OneClick
external_user_id - this is the unique user ID from your system
billing_street_address - The billing address
billing_city - The billing city
billing_state - The ISO code representing the state. (Find lookup in Reference section)
billing_zip - The zip code
billing_country - The ISO code representing the country. (Find lookup in Reference section)
status - 0 indicates success. Anything else indicates an issue
message - Message related to the Status
user_id – the unique OneClick ID number for the newly created user
first_name – first name of the newly created user
last_name – last name of the newly created user
title – job title of the newly created user
email – email address of the newly created user
user_type – the user role as defined in OneClick for the newly created user
company_name – the name of the company associated with this user.
added_date – the date the user was created

User Edit - /api/employer/user/edit

Admin onlyEdit a user in OneClick.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access
user_id - the unique user ID in OneClick
first_name - the first name of the user
last_name - the last name of the user
title - title of the user
email - email address of the user
is_admin - if 1, we will setup the user as an Administrator for their Company in OneClick. If 0, they will be setup as a Recruiter user type without administrative privileges
external_user_id - this is the unique user ID from your system
status - 0 indicates success. Anything else indicates an issue
message - Message related to the Status
user_id – the unique OneClick ID number for the newly created user
first_name – first name of the newly created user
last_name – last name of the newly created user
title – job title of the newly created user
email – email address of the newly created user
user_type – the user role as defined in OneClick for the newly created user
company_name – the name of the company associated with this user.

Login User - /api/employer/user/login

Retrieve Single Sign On (SSO) link to log user into OneClick.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
login_url - the URL to use to SSO the user into OneClick

Get User Info - /api/employer/user/info

Retrieve basic information about the user.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
user_id – OneClick’s unique ID of the authenticated user
first_name – first name of the authenticated user
last_name – last name of the authenticated user
title – job title of the authenticated user
email – email address of the authenticated user
user_type – the user role as defined in OneClick for the authenticated user
billing_street_address - The billing address
billing_city - The billing city
billing_state - The billing state
billing_zip - The zip code
billing_country - The billing
company_id - The unique company ID in JobTarget

Get User Divisions - /api/employer/user/divisions

Retrieve list of all divisions associated with this user in OneClick.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
division_id – the unique ID number for that division in OneClick
name – the name for that division in OneClick

Get User Credit Cards - /api/employer/user/creditcards

Retrieve list of all credit cards associated with this user in OneClick.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
managecc_url - URL to use to manage the user's credit cards
cc_id – the unique ID number for that credit card in OneClick
name – the name assocaited with the card
type – the type of card (Visa, Mastercard, Amex etc).
number – the last 4 digits of the card
exp_month – the expiration month the card
exp_year – the expiration year the card
address - the address associated with the credit card
managecc_url

If you wish to add a redirect to this page on the successful addition of a credit card, simply add a url parameter to the query string.

Example:

https://www.jobtarget.com/oc/sso/cc/7abd283d-e86c-4498-a85d-4255f0030729?url=https%3A%2F%2Fwww.google.com

Please ensure that the URL is URL Encoded.

Get Users Via p_token - /api/employer/user/getusersviaptoken

Retrieve list of all users associated with the channel (p_token).

INPUT OUTPUT
p_token - the partner token that must be passed to authenticate API access

Optional - either company_id or external_company_id

company_id - the company_id of the company you wish to get ueser for
external_company_id - the external_company_id of the company you wish to get ueser for
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
user_id - OneClick's unique ID of the authenticated user
first_name - first name of the authenticated user
last_name - last name of the authenticated user
title - job title of the authenticated user
email - email address of the authenticated user
user_type - the user role as defined in OneClick for the authenticated user
external_user_id - this is the unique user ID from your system
billing_street_address - The billing address
billing_city - The billing city
billing_state - The billing state
billing_zip - The zip code
billing_country - The billing country
company_id - The unique company ID in JobTarget
is_active - See if a company or user is active/inactive in our system

Job Site Lookup - /api/employer/jobsites/lookup

Find job sites in OneClick.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access
search - keyword to search job site name
status - 0 indicates success. Anything else indicates an issue
message - Message related to the Status
site_id – the unique id in OneClick for the job site
site_name – name of the job site
niche – category of the job site

Get Site Info - /api/employer/jobsites/getsiteinfo

Retrieve site info and products for a given job site.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access
site_id - OneClick's ID for the job site you are requesting information for
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
site_name – the name of the job site
site_url – the URL of the job site
site_id – the ID number for this job site in OneClick
product_id – the ID number for this product in OneClick
product_name – the name of the product
product_duration – the number of days the posting would be live on the job site
product_price – the cost of the product on the job site
product_discount_price – the gross cost/discounted price of the product
is_default – 1 indicates this is the default product we present for this job site in OneClick
is_quote – 1 indicates that this product requires we get a price quote

Get Inventory - /api/employer/media/inventory

Retrieve all media accounts & inventory associated with this user (via their division access rights) in OneClick.

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
inventory_id – the unique ID number in OneClick for this particular inventory account
site_id – the ID number for the job site
site_name – the name of the job site
inventory_name – the name of the inventory, as given by the user
inventory_type – the type of media/inventory account (membership, subscription, slot, credit)
credits_total – the original amount of credits purchased
credits_available – the number of credits remaining
start_date – the start date of when the inventory may be used
expire_date – the date when the inventory will expire and no longer be used
status – indicates whether the inventory is active, expired, or disabled

Create Job - /api/employer/jobs/create

Create a job in OneClick

INPUT OUTPUT

Required Fields

token - the user token that must be passed to authenticate API access
requisition_name – this is the unique ID from your system for the client’s job. Usually a requisition number or unique job reference name
company_name – the name of the company to display on the job ads
title – the job title to display on the job ads
description – the job description to display on the job ads
job_view_url – the URL to the webpage on the ATS where a job seeker can read the full job description for this job
apply_url – the URL to the webpage on the ATS where the job seeker would start the application process for this job
city - the city that this position is to be located in
state – the state code representing the state where this job opening is located. (Find lookup in Reference section)
zip - the zip code that this position is to be located in
country – the ISO code representing the country where this job opening is located. (Find lookup in Reference section)

Optional Fields

product_id – Can be used to automatically add products to the shopping cart in OneClick. This is the ID number for the product in OneClick. Supports comma delimited lists
division_id – the ID for the division folder where the job should be placed
experience – the number of years' experience necessary for the job opening (Find lookup in Reference section)
jobfunction – the OneClick ID representing the closest job function for this position. (Find lookup in Reference section)
industry - the OneClick ID representing the closest industry for this position (Find lookup in Reference section)
job_type - the status of employment (full time, part time, etc) (Find lookup in Reference section)
requirements - the job requirements to be display on the job ads
duration - the duration of employment of this opening (Find lookup in Reference section)
travel - the amount of travel required for this position (Find lookup in Reference section)
education - the minimum education requirement for this position (Find lookup in Reference section)
salary_low - the low end dollar amount of this position's salary
salary_high - the high end dollar amount of this position's salary
salary_type - the salary type for the provided low and high salary (Find lookup in Reference section)
contact_name - name of the contact person candidates will reach out to and will be displayed on job ads
contact_email - email of the contact person candidates will reach out to and will be displayed on job ads
contact_phone - contact phone number of the person candidates will reach out to and will be displayed on job ads
contact_ext - contact extension of the person candidates will reach out to and will be displayed on job ads
entrylevel - indicates whether the job is entry-level. (1 = yes, 0 = no)
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
job_manage_url – the URL to use to SSO the user into OneClick and land them on this job to manage it
job_post_url – the URL to use to SSO the user into OneClick and land them on the job to post it to job sites
job_division_url - the URL to use to SSO the user into OneClick and land them on the division selection page
job_cart_url – the URL to use to SSO the user into OneClick and land them in the shopping cart, pre-filled with the products passed in.
job_id – the unique ID in OneClick for this job
apply_url - the URL to the webpage on the ATS where the job seeker would start the application process for this job
city – the name of the city where the job opening is located
company – the name of the company with the job opening
contact_email – the email address to display in the ads, if the advertiser wants to receive applications by email
contact_ext – the extension to the phone number to display in the ads, if the advertiser wants to receive phone calls from applicants
contact_name – the contact person to display in the ads, if the advertiser wants to direct applicants to a particular person
contact_phone – the phone number to display in the ads, if the advertiser wants to have applicants call in
country – the name of the country where the job opening is located
description – the job description/advertisement
duration – the duration of the job, if temporary
education – the minimum education required for the job opening
entrylevel – tndicates whether the job is entry-level
experience – the number of years’ experience necessary for the job opening
function – the job function categorization of the job opening
industry – the industry that the job opening operates in
job_type – the type of job opening it is (full-time, temporary, contract, etc.)
requisition_name – the unique requisition number or job reference name in the ATS
position – the job title for the job opening
requirements – the description of the job requirements for this job opening
salary_high – the high range number for the salary
salary_low – the low range number for the salary
salary_type – the type of salary (hourly or annual), as it relates to the salary range
state – the name of the state/province where the job opening is located
travel – the amount of travel necessary for the job opening
zip – the zip/postal code for where the job opening is located

Edit Job/Postings - /api/employer/jobs/edit

Edit a job in OneClick

INPUT OUTPUT

Required Fields

token - the user token that must be passed to authenticate API access
job_id – this is the job_id of the job you which to edit
company_name – the name of the company to display on the job ads
title – the job title to display on the job ads
description – the job description to display on the job ads
jobfunction – the OneClick ID representing the closest job function for this position. (Find lookup in Reference section)
job_view_url – the URL to the webpage on the ATS where a job seeker can read the full job description for this job
apply_url – the URL to the webpage on the ATS where the job seeker would start the application process for this job
city - the city that this position is to be located in
state – the state code representing the state where this job opening is located. (Find lookup in Reference section)
zip - the zip code that this position is to be located in
country – the ISO code representing the country where this job opening is located. (Find lookup in Reference section)

Optional Fields

product_id – Can be used to automatically add products to the shopping cart in OneClick. This is the ID number for the product in OneClick. Supports comma delimited lists
division_id – the ID for the division folder where the job should be placed
experience – the number of years' experience necessary for the job opening (Find lookup in Reference section)
jobfunction – the OneClick ID representing the closest job function for this position. (Find lookup in Reference section)
industry - the OneClick ID representing the closest industry for this position (Find lookup in Reference section)
job_type - the status of employment (full time, part time, etc) (Find lookup in Reference section)
requirements - the job requirements to be display on the job ads
duration - the duration of employment of this opening (Find lookup in Reference section)
travel - the amount of travel required for this position (Find lookup in Reference section)
education - the minimum education requirement for this position (Find lookup in Reference section)
salary_low - the low end dollar amount of this position's salary
salary_high - the high end dollar amount of this position's salary
salary_type - the salary type for the provided low and high salary (Find lookup in Reference section)
contact_name - name of the contact person candidates will reach out to and will be displayed on job ads
contact_email - email of the contact person candidates will reach out to and will be displayed on job ads
contact_phone - contact phone number of the person candidates will reach out to and will be displayed on job ads
contact_ext - contact extension of the person candidates will reach out to and will be displayed on job ads
entrylevel - indicates whether the job is entry-level. (1 = yes, 0 = no)
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
job_manage_url – the URL to use to SSO the user into OneClick and land them on this job to manage it
job_post_url – the URL to use to SSO the user into OneClick and land them on the job to post it to job sites
job_cart_url – the URL to use to SSO the user into OneClick and land them in the shopping cart, pre-filled with the products passed in.
job_id – the unique ID in OneClick for this job
apply_url - the URL to the webpage on the ATS where the job seeker would start the application process for this job
city – the name of the city where the job opening is located
company – the name of the company with the job opening
contact_email – the email address to display in the ads, if the advertiser wants to receive applications by email
contact_ext – the extension to the phone number to display in the ads, if the advertiser wants to receive phone calls from applicants
contact_name – the contact person to display in the ads, if the advertiser wants to direct applicants to a particular person
contact_phone – the phone number to display in the ads, if the advertiser wants to have applicants call in
country – the name of the country where the job opening is located
description – the job description/advertisement
duration – the duration of the job, if temporary
education – the minimum education required for the job opening
entrylevel – tndicates whether the job is entry-level
experience – the number of years’ experience necessary for the job opening
function – the job function categorization of the job opening
industry – the industry that the job opening operates in
job_type – the type of job opening it is (full-time, temporary, contract, etc.)
requisition_name – the unique requisition number or job reference name in the ATS
position – the job title for the job opening
requirements – the description of the job requirements for this job opening
salary_high – the high range number for the salary
salary_low – the low range number for the salary
salary_type – the type of salary (hourly or annual), as it relates to the salary range
state – the name of the state/province where the job opening is located
travel – the amount of travel necessary for the job opening
zip – the zip/postal code for where the job opening is located

Get User Jobs - /api/employer/jobs/userjobs

List of jobs associated with the user, based upon a specific time duration.

INPUT OUTPUT
token - the user token that must be passed to authenicate API access
days - how far back (in days) you wish to retrieve jobs (based upon last updated date)
status - 0 indicates success. Anything else indicates an issue
message - message related to the status
job_id – JobTarget’s unique Job ID
requisition_name – this is the unique ID from your system for the client’s job. Usually a requisition number or unique job reference name
position – this is the job title
division_id – this is the ID of the OneClick division folder the job belongs to
division_name – this is the name of the OneClick division folder the job belongs to
updated_date – date/time stamp of when the job was last updated in OneClick
created_date – date/time stamp of when job was created in OneClick
job_manage_url – the URL to use to Single Sign On (SSO) the user into OneClick and land them on this job to manage it
job_post_url – the URL to use to SSO the user into OneClick and land them on the job to post it to job sites

Get User Division Jobs - /api/employer/jobs/userdivisionjobs

List of jobs associated with user' divisions, based upon a specific time duration.

INPUT OUTPUT
token - the user token that must be passed to authenicate API access
days - how far back (in days) you wish to retrieve jobs (based upon last updated date)
status - 0 indicates success. Anything else indicates an issue
message - message related to the status
job_id – JobTarget’s unique Job ID
requisition_name – this is the unique ID from your system for the client’s job. Usually a requisition number or unique job reference name
position – this is the job title
division_id – this is the ID of the OneClick division folder the job belongs to
division_name – this is the name of the OneClick division folder the job belongs to
updated_date – date/time stamp of when the job was last updated in OneClick
created_date – date/time stamp of when job was created in OneClick
job_manage_url – the URL to use to Single Sign On (SSO) the user into OneClick and land them on this job to manage it
job_post_url – the URL to use to SSO the user into OneClick and land them on the job to post it to job sites

Get Job Details / Postings - /api/employer/jobs/jobdetails

Get the details of a particular job, including all of the postings and related posting information.

INPUT OUTPUT
token - the user token that must be passed to authenicate API access

This function requires either job_id or requisition_name

job_id - OneClick’s unique id number for the job

requisition_name - this is the unique ID from your system for the client’s job. Usually a requisition number or unique job reference name

Optional Parameters
exclude_postings - set this to 1 to exclude pulling posting data (optional)
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
job_id – JobTarget’s unique Job ID
job_manage_url – the URL to use to SSO the user into OneClick and land them on this job to manage it
job_post_url – the URL to use to SSO the user into OneClick and land them on the job to post it to job sites
job_analytics – job-level performance
views – the aggregate count of views the job received on the job sites
visits – the aggregate count of visits delivered to the ATS for the job
apps – the aggregate count of applications delivered from the job sites
interviews – the aggregate count of interviews created from the applicants
hires – the aggregate count of hires created from the applicants
apply_url - the URL to the webpage on the ATS where the job seeker would start the application process for this job
city – the name of the city where the job opening is located
company – the name of the company with the job opening
contact_email – the email address to display in the ads, if the advertiser wants to receive applications by email
contact_ext – the extension to the phone number to display in the ads, if the advertiser wants to receive phone calls from applicants
contact_name – The contact person to display in the ads, if the advertiser wants to direct applicants to a particular person
contact_phone – The phone number to display in the ads, if the advertiser wants to have applicants call in
country – the name of the country where the job opening is located
description – the job description/advertisement
duration – the duration of the job, if temporary
education – the minimum education required for the job opening
entrylevel – indicates whether the job is entry-level
experience – the number of years’ experience necessary for the job opening
function – the job function categorization of the job opening
industry – the industry that the job opening operates in
job_type – the type of job opening it is (full-time, temporary, contract, etc.)
requisition_name – the unique requisition number or job reference name in the ATS
position – the job title for the job opening
requirements – the description of the job requirements for this job opening
salary_high – the high range number for the salary
salary_low – the low range number for the salary
salary_type – the type of salary (hourly or annual), as it relates to the salary range
state – the name of the state/province where the job opening is located
travel – the amount of travel necessary for the job opening
zip – the zip/postal code for where the job opening is located
posting_id – the unique id in OneClick for this posting. Please note that a posting is a unique instance of a job listed on a job site
site_id – the OneClick id for the job site related to this posting
site_name – the name of the job site related to this posting
status – the current delivery status of the posting to the job site
ordered_date – the date the posting was ordered
expired_date – the date the posting will expire on the job site
view_url – the URL to view the job on the job site (if posting still active)
product_id – the OneClick id for the product related to this posting
analytics – posting-level performance analytics
views – the aggregate count of views the job received for this posting
visits – the aggregate count of visits delivered to the ATS for this posting
apps – the aggregate count of applications delivered from this job posting
interviews – the aggregate count of interviews created from the applicants of this job posting
hires – the aggregate count of hires created from the applicants of this job posting

Get Job Details via p_token- /api/employer/jobs/jobdetailsviaptoken

Get the details of a particular job, including all of the postings and related posting information.

INPUT OUTPUT
p_token - the partner token/key that must be passed to authenticate API access

This function requires either job_id or requisition_name

job_id - OneClick’s unique id number for the job

requisition_name - this is the unique ID from your system for the client’s job. Usually a requisition number or unique job reference name

Optional Parameters
company_id - the company_id associated with the job (optional)
exclude_postings - set this to 1 to exclude pulling posting data (optional)
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
job_id – JobTarget’s unique Job ID
job_analytics – job-level performance
views – the aggregate count of views the job received on the job sites
visits – the aggregate count of visits delivered to the ATS for the job
apps – the aggregate count of applications delivered from the job sites
interviews – the aggregate count of interviews created from the applicants
hires – the aggregate count of hires created from the applicants
apply_url - the URL to the webpage on the ATS where the job seeker would start the application process for this job
city – the name of the city where the job opening is located
company – the name of the company with the job opening
contact_email – the email address to display in the ads, if the advertiser wants to receive applications by email
contact_ext – the extension to the phone number to display in the ads, if the advertiser wants to receive phone calls from applicants
contact_name – The contact person to display in the ads, if the advertiser wants to direct applicants to a particular person
contact_phone – The phone number to display in the ads, if the advertiser wants to have applicants call in
country – the name of the country where the job opening is located
description – the job description/advertisement
duration – the duration of the job, if temporary
education – the minimum education required for the job opening
entrylevel – indicates whether the job is entry-level
experience – the number of years’ experience necessary for the job opening
function – the job function categorization of the job opening
industry – the industry that the job opening operates in
job_type – the type of job opening it is (full-time, temporary, contract, etc.)
requisition_name – the unique requisition number or job reference name in the ATS
position – the job title for the job opening
requirements – the description of the job requirements for this job opening
salary_high – the high range number for the salary
salary_low – the low range number for the salary
salary_type – the type of salary (hourly or annual), as it relates to the salary range
state – the name of the state/province where the job opening is located
travel – the amount of travel necessary for the job opening
zip – the zip/postal code for where the job opening is located
posting_id – the unique id in OneClick for this posting. Please note that a posting is a unique instance of a job listed on a job site
site_id – the OneClick id for the job site related to this posting
site_name – the name of the job site related to this posting
status – the current delivery status of the posting to the job site
ordered_date – the date the posting was ordered
expired_date – the date the posting will expire on the job site
view_url – the URL to view the job on the job site (if posting still active)
product_id – the OneClick id for the product related to this posting
analytics – posting-level performance analytics
views – the aggregate count of views the job received for this posting
visits – the aggregate count of visits delivered to the ATS for this posting
apps – the aggregate count of applications delivered from this job posting
interviews – the aggregate count of interviews created from the applicants of this job posting
hires – the aggregate count of hires created from the applicants of this job posting

Stop Job - /api/employer/jobs/stopjob

This will stop all of the postings associated with a particular job.

INPUT OUTPUT
token - the user token that must be passed to authenicate API access
job_id - OneClick’s unique id number for the job you wish to stop
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status

Stop Job Via p_token- /api/employer/jobs/stopjobviaptoken

This will stop all of the postings associated with a particular job, via a p_token.

INPUT OUTPUT
p_token - the p_token that is used to authenicate API access
job_id - OneClick’s unique id number for the job you wish to stop
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status

Create Posting - /api/employer/jobs/createposting

This will create a job posting

INPUT OUTPUT
token - the user token that must be passed to authenicate API access
job_id - OneClick’s unique id number for the job whose posting you wish to stop
cc_id - the credit card id you wish to use to pay for the transaction (if paying by invoice simply use invoice as the cc_id)
site_id - the id of the site to where you want to post the job
product_id - OneClick’s unique id number for the product you want to use
inventory_id - OneClick’s unique id number for the inventory you want to use (optional)
name - the custom field name for the job post (I will provide a function to display the fields)
value - the value corresponing to the named field
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
order_id - the order id that is generated for the postings
order_date - the date of the order
is_order_paid - indicates if the order is paid or not

posting
status - 0 indicates success. Anything else indicates an issue
posting_id -the generated posting id
order_item_id - the generated order item id for the given posting
cost - the cost associated with the posting
site_name - the name of the site
product_id - OneClick’s unique id number for the product you want to use
product_name - the name of the product
product_duration - the number of days the posting will be active on the chosen site
payment_type - the method of payment

Stop Posting - /api/employer/jobs/stopposting

This will stop the specified job posting.

INPUT OUTPUT
token - the user token that must be passed to authenicate API access
job_id - OneClick’s unique id number for the job whose posting you wish to stop
posting_id - OneClick’s unique id number for the job posting you wish to stop
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status

Get State Codes - /api/employer/reference/state

Retrieve geographical state information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
iso_state_code – the ISO code representing that state/province.
name – the name of the state/province.

Get Country Codes - /api/employer/reference/country

Retrieve country information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
name – the name of the country.
iso_country_code – the ISO code representing that country.

Get Job Function Codes - /api/employer/reference/jobfunction

Retrieve job function information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
job_function_id – the unique id in OneClick representing that job function.
name – the name of the jobfunction.

Get Industry Codes - /api/employer/reference/industry

Retrieve industry information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
industry_id – the unique id in OneClick representing that industry.
name – the name of the industry.

Get Job Type Codes - /api/employer/reference/jobtype

Retrieve job type information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
job_type_id – the unique id in OneClick representing that job type.
name – the name of the job type.

Get Duration Codes - /api/employer/reference/duration

Retrieve job duration information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
duration_id – the unique id in OneClick representing that duration type.
name – the name of the duration type.

Get Travel Codes - /api/employer/reference/travel

Retrieve job travel information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
travel_id – the unique id in OneClick representing that travel type.
name – the name of the travel type.

Get Education Codes - /api/employer/reference/education

Retrieve job education information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
education_id – the unique id in OneClick representing that education type.
name – the name of the education type.

Get Salary Type Codes - /api/employer/reference/salarytype

Retrieve job salary information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
salary_id – the unique id in OneClick representing that salary type.
name – the name of the salary type.

Get Experience Codes - /api/employer/reference/experience

Retrieve job experience information

INPUT OUTPUT
token - the user token that must be passed to authenticate API access status - 0 indicates success. Anything else indicates an issue.
message - message related to the status.
experience_id – the unique id in OneClick representing that experience level.
name – the name of the experience level.

Validate JSON - /api/employer/reference/isjsonvalid

Validates input to determine whether it is valid JSON

INPUT OUTPUT
input - any string you want validated as JSON is_valid - if the input is valid JSON then true otherwise false

Validate Location - /api/employer/reference/location

Validates address by returning matches via Google Search API (including misspellings)

INPUT OUTPUT
location - address you wich to have validated (it takes in misspellings and returns the correct address) status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
location - a valid location if found

Zip Code Lookup - /api/employer/reference/zipcode

Returns a list of zip code for a given city

INPUT OUTPUT
city - the name of the city you wish to lookup zip codes for
state - state associcated with the coty
status - 0 indicates success. Anything else indicates an issue
message - message related to the Status
zipcode - the zip code associated with the city

 

This document is designed to help our partners better understand the typical manner in which partners use our API to integrate OneClick into their ATS user experience.

API Notes

 

The Basics

Authenticating Users in OneClick

One of the first things you need to do is authenticate the user with the OneClick system. The first time a company launches with OneClick, it will be an offline process of us setting up the company and its first set of users. For each new user to be added post launch, an admin from the company should add the user within the OneClick platform. We will also establish and store your IP Range which helps add another layer of authentication. You must be making the API call from within your designated IP range. You will supply us your IP range and we will only allow authentication based on that range.

Once a user is configured in OneClick, you may use the OneClick Employer API for various functions.

The first step will be to authenticate the user. You would use the Get User Token function (Authentication) to do that. Here is an example input/output:

Input Output

{
  "p_token": "1DB2C510-4CC3-44FE-A22F-A100B657602C",
  "email": "bilbob@none.com"
}

{
"status": 0,
"message": "success",
"token": "f67f7533-874e-469d-a52d-1bc870009881"
}

We offer an optional authentication restriction called UID (User ID). These IDs are generated hash values that we provide for each user. To authenticate a user when UID is enabled you must pass in the p_token, email address and corresponding UID. If you would like to enable UID authentication we will provide you all the UIDs.

 

Porting User Over to OneClick with a Job

This is the core user experience the users are expecting and need. That is, they can take a job opening in the ATS and then port it (and themselves) over to OneClick to then advertise that job opening on external job sites. Within the ATS, there are a couple of launch points of this process. First, it would be at the end of the user adding a new job into the ATS. At that point, you would present the user a message and link that states “Click Here to now advertise this job to job sites on the Internet – via JobTarget OneClick”. The second place would be from their existing jobs list in the ATS. Next to each job, they should have a button/link to “Post on Job Sites”. This would then initiate the functions to port the job over to OneClick with the user.

You will do this, by employing the Create Job/Postings function (Jobs/Postings). Please note that our system operates on unique values for requisition_name per Company - meaning one Company may not have two different jobs with the same requisition_name value. Also, you will need to submit numeric values for some of the inputs. We offer lookup functions in the Reference section.

After you create the job in the OneClick system, the output will return a couple of URLs. Use the job_post_url to immediately send the user along to us. This will SSO the user into OneClick and drop them into the User Experience to post this job. The job_manage_url may be used to send the user back at a future time to manage the job and its postings in the OneClick system. Here is an example of this function. 

Input Output

{
"token": "f67f7533-874e-469d-a52d-1bc870009881",
"job": {
"requisition_name": "my-new-job12",
"company_name": "ABC Corp",
"title": "SQL DBA",
"description": "you have to do dba stuff and work with devs",
"jobfunction": 65,
"job_view_url": "http://www.jobview.com/position/12345",
"apply_url": "http://www.applyhere.com/234",
"location": {
"state": "CT",
"country": "US"
}
}
}

 

{
"status": 0,
"message": "success",
"job_manage_url": "https://www.jobtarget.com/oc/sso/edit/f67f7533-874e-469d-a52d-1bc870009881/24116184",
"job_post_url": "https://www.jobtarget.com/oc/sso/post/f67f7533-874e-469d-a52d-1bc870009881/24116184",
"job_id": 24116184,
"job": {
"anonymous": "0",
"apply_online": "0",
"apply_url": "http://www.applyhere.com/234",
"city": "",
"company": "ABC Corp",
"company_profile": "0",
"contact_email": "",
"contact_ext": "",
"contact_fax": "",
"contact_name": "",
"contact_phone": "",
"country": "United States",
"description": "you have to do dba stuff and work with devs",
"duration": "",
"education": "",
"entrylevel": "0",
"experience": "",
"function": "Manufacturing",
"industry": "",
"job_type": "",
"name": "my-new-job12",
"position": "SQL DBA",
"recipients": "",
"requirements": "",
"salary_high": "",
"salary_low": "",
"salary_type": "",
"state": "Alaska",
"template_save": "0",
"travel": "",
"zip": ""
}
}

 


Logging a User into OneClick

You will want to provide the user the ability to log into OneClick to manage their recruitment advertising. This makes the integration between ATS and OneClick seamless for the user. There should be a link or button in the main navigation of your ATS for “JobTarget OneClick” or something similar.

When the user clicks this button/link, you will execute the Login User function (User). This will log the user in and land them on their Dashboard page in OneClick. Here is an example of that function:

Input Output

{
"token": "f67f7533-874e-469d-a52d-1bc870009881"
}

{
"status": 0,
"message": "success",
"url": "http://www.jobtarget.com/oc/sso/f67f7533-874e-469d-a52d-1bc870009881"
}

 

Create Company

This function has 3 required input fields:

We also offer an optional input field called industry_id. You can pass in the OneClick ID representing the industry for the new company. Use the industry lookup function in the reference section.

The new company will be configured as an enterprise in OneClick. We will also create a default division within the enterprise called "Imported Jobs". This default division is required for creating jobs.

 

Create User

All input fields for this function are required:

The new user will automatically be granted access to all divisions within their company.

 

Managing from Within the ATS

These are additional tools that are provided to the user within the ATS that do not require them to log back into OneClick to get the information they need.

Show Postings in ATS

You may decide there is value in showing users where their jobs are advertised on the Internet from within your ATS. You can display the job site name, the current posting status, the expiration date, and performance analytics.

To pull this data, you can use the following functions:

Input Output

{
"token": "f67f7533-874e-469d-a52d-1bc870009881",
"job_id": 24004653
}

{
"status": 0,
"message": "success",
"job_id": 24004653,
"job_manage_url": "https://www.jobtarget.com/oc/sso/edit/f67f7533-874e-469d-a52d-1bc870009881/24004653",
"job_post_url": "https://www.jobtarget.com/oc/sso/post/f67f7533-874e-469d-a52d-1bc870009881/24004653",
"job_analytics": {
"views": 0,
"visits": 0,
"apps": 0,
"interviews": 0,
"hires": 0
},
"job_details": {
"anonymous": "0",
"apply_online": "0",
"apply_url": "www.url.com",
"city": "",
"company": "The Shire",
"company_profile": "0",
"contact_email": "",
"contact_ext": "",
"contact_fax": "",
"contact_name": "",
"contact_phone": "",
"country": "United States",
"description": "test",
"duration": "",
"education": "",
"entrylevel": "0",
"experience": "",
"function": "Information Technology",
"industry": "",
"job_type": "",
"name": "12345",
"position": "test",
"recipients": "",
"requirements": "",
"salary_high": "",
"salary_low": "",
"salary_type": "",
"state": "Guam",
"template_save": "0",
"travel": "",
"zip": ""
},
"postings": [
{
"posting_id": 92720150,
"site_id": 3854,
"site_name": "LinkedIn",
"status": "expired",
"posted_date": "2016-01-15T00:00:00",
"expired_date": "2016-02-15T00:00:00",
"proof_date": null,
"view_url": null,
"product_id": 34578,
"analytics": {
"views": 0,
"visits": 0,
"apps": 0,
"interviews": 0,
"hires": 0
}
},
{
"posting_id": 92720151,
"site_id": 5923,
"site_name": "NpJobs.com",
"status": "expired",
"posted_date": "2016-01-15T00:00:00",
"expired_date": "2016-01-19T10:16:23.67",
"proof_date": null,
"view_url": null,
"product_id": 52160,
"analytics": {
"views": 0,
"visits": 0,
"apps": 0,
"interviews": 0,
"hires": 0
}
},
{
"posting_id": 92825488,
"site_id": 12138,
"site_name": "JobTarget Sales Demo Site",
"status": "active",
"posted_date": "2016-02-04T00:00:00",
"expired_date": "2016-03-06T00:00:00",
"proof_date": null,
"view_url": null,
"product_id": 109330,
"analytics": {
"views": 0,
"visits": 0,
"apps": 0,
"interviews": 0,
"hires": 0
}
},
{
"posting_id": 92825487,
"site_id": 20176,
"site_name": "Job Board ATS Demo",
"status": "active",
"posted_date": "2016-02-04T00:00:00",
"expired_date": "2016-04-05T00:00:00",
"proof_date": null,
"view_url": null,
"product_id": 167232,
"analytics": {
"views": 0,
"visits": 0,
"apps": 0,
"interviews": 0,
"hires": 0
}
}
]
}

 

Analytics

Analytics Code Drop

JobTarget provides source tracking on all job postings submitted through the OneClick platform. To provide your users full source tracking that includes Views, Visits and Applications, you need to add our Analytics Code Drop to your site. This system is also used to better determine Source of Candidate as we can tie in indirect activity. Additionally, once the code drop is in place, your ATS can send JobTarget information about Interviews and Hires so that your customer can review how their media is performing when it comes to making the best hires for their company.

Each code drop is unique to the ATS. Our development team will review a sample career site to determine which pages would require the code drop and provide the detailed instructions on where to place each piece of code.

Once the code is in place, our team will perform some testing to ensure all tracking data is being captured. We will also use this time to work with you on mapping the source tracking data to your ATS platform. This will allow you to take the source tracking from each posting that the user submits to external job sites and show that data within your ATS platform in real time. 

Contact your rep to get your ATS specific code drop information!

Referral and Source Data

We can provide Candidate Source data via the job seeker traffic we deliver back to you. This mostly involves the capture of referrer (the full URL that the apply_url was clicked from), source (the job board the job was posted to), and the job board ID (to map the data to a job board in your system) for each click of the apply URL. In order to provide as much information to your customers as possible, the OneClick system captures all of this information for you. You do not need to provide us different URLs for different job boards, as that is impractical and won't work with the OneClick system.

JobTarget adds up to four query string variables to job posting links to pass you additional information when an applicant clicks the link. All variables are added to the query string and url-encoded.  If you’re unsure of what this means, please see http://en.wikipedia.org/wiki/Url_encode

The data will be appended to the submitted job’s apply_url as follows:

<apply_url>&jtsrc=http%3A%2F%2Fpowerpost%2Ejobtarget%2Ecom&jtrfr=http%3A%2F%2Fwww%2Eindeed%2Ecom%2Fjobs%3Fq%3Djobtarget%26l%3D06320&jtsrcid=12345

The benefit of adding the data with this method is that your system is able to include any URL variables for tracking that it needs – OneClick will only append these variables to the end of the apply_url and will not make any changes otherwise. By default all four variables will be appended at all times. To have any or all of them removed please contact you point of contact at JobTarget. If you would like to store the referrer/source data we recommend creating an ‘intermediary’ page to parse and manage the referrer, source, job board, and job_id data.   This process involves receiving a URL, saving, storing, or mapping the HTTP GET values, and redirecting the user to the standard job details page.

 

Bulk Job Imports

API or XML

A critical component of JobTarget's service is autorouting a customer's jobs to various job sites. To do this on behalf of the customer, we need to bulk import all of a customer's jobs automatically into OneClick. Our ATS partners typically provide us one of two methods to do this. One way is if your ATS offers an API to interact with a customer's jobs. We will build against this API to configure the system to either do a daily sync or an on-demand sync. When this occurs, we will port over all of a customers jobs from the ATS; adding what is new, editing what has changes, and removing what is now gone. The second method we sometimes use is to consume an XML feed of a customer's jobs. Each time we onboard a customer, we will be provided an XML feed of their jobs which we will process either daily or more frequently, depending upon the needs of the customer. Please reach out to your JobTarget contact and explain which methodology you can offer.

12/6/16 - Added 2 new API functions. Create Company which can be found on the Company tab. Create User which can be found on the User tab.

9/6/16 - New feature added! You can now pass in product IDs when creating and editing jobs. These products will be populated in your cart when you SSO into OneClick.

4/8/16 - Updated country and state codes to ISO-3166

3/23/16 - Added Cross-Origin Request (CORS) support

3/1/16 – We added new outputs to the Authentication function. When you successfully authenticate a user, the output will tell you more information about that user, including whether they are an Admin in OneClick.

3/1/16 – Added 3 new API Functions (all in the Jobs/Postings section). One to Edit a Job in the OneClick system. One to Stop All Postings associated with a job. And one to Stop a Posting.

2/24/16 – OneClick Employer API Version 2.0 is released.

2/24/16 – JobTarget announces that support for OneClick Employer API Version 1.0 will end on March 1, 2017. All partners must upgrade to new API prior to that date.