PCRecruiter

Welcome!

Welcome to the new PCRecruiter API documentation website!

We plan to use this area to announce upcoming changes and additions to our API, so please keep an eye out here for future announcements.

Get Started!

Skip to content

PCRecruiter API

Search... K

Main Navigation API Reference Additional References

Appearance

Sidebar Navigation

Getting Started

Welcome to the PCRecruiter API Docs

Quick Start Guide

API Reference

access-token

GET Retrieve a valid API session

POST Retrieve a valid API session

DELETE Remove session token and logoff user

globalV2/attachments

GET Search for Attachment records

PUT Update a(n) Attachment record

POST Create a(n) Attachment record

globalV2/attachments/{id}

GET Retrieve a(n) Attachment record

PUT Update a(n) Attachment record

DELETE Delete a(n) Attachment record

calendar

GET Search for Calendar records

PUT Update a(n) Calendar record

POST Create a(n) Calendar record

calendar/{id}

GET Retrieve a(n) Calendar record

PUT Update a(n) Calendar record

DELETE Delete a(n) Calendar record

calendar/{id}/meetingrequest

PUT Create meeting request for an existing calendar item and return .ics file

calendar/events

GET Get calendar by date

campaigns/Recipients

GET Search for Recipient records

PUT Update a(n) Recipient record

POST Create a(n) Recipient record

campaigns/Recipients/{id}

GET Retrieve a(n) Recipient record

PUT Update a(n) Recipient record

DELETE Delete a(n) Recipient record

candidates

candidates/{CandidateId}/notes

GET Gets all of the notes associated with this candidate

PUT Update a note to a candidate

POST Add a note to a candidate

candidates/{CandidateId}/notes/{NoteId}

DELETE Delete a note to a candidate

candidates/{candidateId}/{resumeType}

GET Gets a candidate resume

PUT Update a resume entry for the candidate.

POST Creates a new resume entry for the candidate.

DELETE Delete a resume entry for the candidate.

candidates/{candidateId}/{resumeType}/binary

GET GET /candidates/{candidateId}/{resumeType}/binary

candidates/{candidateId}/{resumeType}/download

GET GET /candidates/{candidateId}/{resumeType}/download

candidates/resumes

GET Search for Resume V2 records

PUT Update a(n) Resume V2 record

POST Create Resume

candidates/resumes/{candidateId}

POST Create Resume for candidate.

candidates/resumes/{candidateId}/all

GET Retrieve all resumes for a candidate

candidates/resumes/{id}

GET Get Resume

PUT PUT /candidates/resumes/{id}

DELETE Delete a(n) Resume V2 record

candidates/resumes/download/{id}

GET Get Download formatted resume

candidatesV2

GET Search for Candidate V2 records

PUT Update a(n) Candidate V2 record

POST Create a(n) Candidate V2 record

candidatesV2/{id}

GET Retrieve a(n) Candidate V2 record

PUT Update a(n) Candidate V2 record

DELETE Delete a(n) Candidate V2 record

candidatesV2/activities

GET Search for Candidate Activity V2 records

PUT Update a(n) Candidate Activity V2 record

POST Create a(n) Candidate Activity V2 record

candidatesV2/activities/{id}

GET Retrieve a(n) Candidate Activity V2 record

PUT Update a(n) Candidate Activity V2 record

DELETE Delete a(n) Candidate Activity V2 record

candidatesV2/attachments

GET Search for Candidate Attachment records

PUT Update a(n) Candidate Attachment record

POST Create a(n) Candidate Attachment record

candidatesV2/attachments/{id}

GET Retrieve a(n) Candidate Attachment record

PUT Update a(n) Candidate Attachment record

DELETE Delete a(n) Candidate Attachment record

candidatesV2/CandidatesV2/{id}

PUT Update a(n) Candidate V2 record

candidatesV2/customfields

GET Search for Candidate Field V2 records

PUT Update a(n) Candidate Field V2 record

POST Create a(n) Candidate Field V2 record

candidatesV2/customfields/{id}

GET Retrieve a(n) Candidate Field V2 record

PUT Update a(n) Candidate Field V2 record

DELETE Delete a(n) Candidate Field V2 record

candidatesV2/Education

GET Search for Education records

PUT Update a(n) Education record

POST Create a(n) Education record

candidatesV2/Education/{id}

GET Retrieve a(n) Education record

PUT Update a(n) Education record

DELETE Delete a(n) Education record

candidatesV2/Licensing

GET Search for Licensing records

PUT Update a(n) Licensing record

POST Create a(n) Licensing record

candidatesV2/Licensing/{id}

GET Retrieve a(n) Licensing record

PUT Update a(n) Licensing record

DELETE Delete a(n) Licensing record

candidatesV2/Military

GET Search for Military records

PUT Update a(n) Military record

POST Create a(n) Military record

candidatesV2/Military/{id}

GET Retrieve a(n) Military record

PUT Update a(n) Military record

DELETE Delete a(n) Military record

candidatesV2/References

GET Search for References records

PUT Update a(n) References record

POST Create a(n) References record

candidatesV2/References/{id}

GET Retrieve a(n) References record

PUT Update a(n) References record

DELETE Delete a(n) References record

candidatesV2/WorkHistory

GET Search for Work History records

PUT Update a(n) Work History record

POST Create a(n) Work History record

candidatesV2/WorkHistory/{id}

GET Retrieve a(n) Work History record

PUT Update a(n) Work History record

DELETE Delete a(n) Work History record

companies

companies/{CompanyId}/notes

GET Gets all of the notes associated with this company

PUT Update a note to a company

POST Add a note to a company

companies/{CompanyId}/notes/{Noteid}

DELETE Delete a note to a company

companies/rolluplists

GET Search for Company Rollup Records

companies/rolluplists/{RollupCode}

GET Search for Company Rollup Records by Rollup Code

companies/rolluplists/{RollupCode}/{CompanyId}

GET Get a Company Rollup Record by Rollup Code and Company ID

PUT Update a Company Rollup Record

POST Add a Company to a Rollup List

DELETE Remove a Company from a Rollup List

companiesV2

GET Search for Company V2 records

PUT Update a(n) Company V2 record

POST Create a(n) Company V2 record

companiesV2/{id}

GET Retrieve a(n) Company V2 record

PUT Update a(n) Company V2 record

DELETE Delete a(n) Company V2 record

companiesV2/activities

GET Search for Company Activity V2 records

PUT Update a(n) Company Activity V2 record

POST Create a(n) Company Activity V2 record

companiesV2/activities/{id}

GET Retrieve a(n) Company Activity V2 record

PUT Update a(n) Company Activity V2 record

DELETE Delete a(n) Company Activity V2 record

companiesV2/attachments

GET Search for Company Attachment records

PUT Update a(n) Company Attachment record

POST Create a(n) Company Attachment record

companiesV2/attachments/{id}

GET Retrieve a(n) Company Attachment record

PUT Update a(n) Company Attachment record

DELETE Delete a(n) Company Attachment record

companiesV2/customfields

GET Search for Company Field V2 records

PUT Update a(n) Company Field V2 record

POST Create a(n) Company Field V2 record

companiesV2/customfields/{id}

GET Retrieve a(n) Company Field V2 record

PUT Update a(n) Company Field V2 record

DELETE Delete a(n) Company Field V2 record

formletter

GET Search for Form Letter records

PUT Update a(n) Form Letter record

POST Create a(n) Form Letter record

formletter/{id}

GET Retrieve a(n) Form Letter record

PUT Update a(n) Form Letter record

DELETE Delete a(n) Form Letter record

formletter/{recordType}

GET Search for Form Letters

formletter/{recordType}/{id}

GET Get Form Letter

PUT Update Form Letter

notifications

GET Search for Notification records

PUT Update a(n) Notification record

POST Create a(n) Notification record

notifications/{id}

GET Retrieve a(n) Notification record

PUT Update a(n) Notification record

DELETE Delete a(n) Notification record

notifications/my

GET Retrieve notifications for current user

notifications/Notifications/{id}

DELETE Delete a(n) Notification record

null

PUT This function returns an empty result set. Useful if you need to make an API call that return nothing, such as when sending Change Tracking commands.

pipelineactivities

GET Search for Pipeline Activity records

PUT Update a(n) Pipeline Activity record

POST Create a(n) Pipeline Activity record

pipelineactivities/{id}

GET Retrieve a(n) Pipeline Activity record

PUT Update a(n) Pipeline Activity record

DELETE Delete a(n) Pipeline Activity record

PipelineInterviews

GET Search for Pipeline Interview records

PUT Update a(n) Pipeline Interview record

POST Create a(n) Pipeline Interview record

PipelineInterviews/{id}

GET Retrieve a(n) Pipeline Interview record

PUT Update a(n) Pipeline Interview record

DELETE Delete a(n) Pipeline Interview record

PipelinePlacements

GET Search for Pipeline Placement records

PUT Update a(n) Pipeline Placement record

POST Create a(n) Pipeline Placement record

PipelinePlacements/{id}

GET Retrieve a(n) Pipeline Placement record

PUT Update a(n) Pipeline Placement record

DELETE Delete a(n) Pipeline Placement record

pipelinesteps

GET Search for Pipeline Step records

PUT Update a(n) Pipeline Step record

POST Create a(n) Pipeline Step record

pipelinesteps/{id}

GET Retrieve a(n) Pipeline Step record

PUT Update a(n) Pipeline Step record

DELETE Delete a(n) Pipeline Step record

pipelinesteps/counts/{stepid}

GET Get counts for applicants currently on this step, who have ever been on this step, and have an activity for this step.

positions

positions/{JobId}/associations/rolluplists

GET Get all Rollup Lists associated with the job ID

positions/{JobId}/associations/rolluplists/{RollupCode}

POST Associate the Rollup List to the specified position

positions/{JobId}/notes

GET Gets all of the notes associated with this position

PUT Update a note to a position

POST Add a note to a position

positions/{JobId}/notes/{NoteId}

DELETE Delete a note to a position

positions/rolluplists

GET Search for Position Rollup Records

positions/rolluplists/{RollupCode}

GET Search for Position Rollup Records by Rollup Code

positions/rolluplists/{RollupCode}/{JobId}

GET Get a Position Rollup Record by Rollup Code and Position ID

PUT Update a Position Rollup Record

POST Add a Position to a Rollup List

DELETE Remove a Position from a Rollup List

positionsV2

GET Search for Position V2 records

PUT Update a(n) Position V2 record

POST Create a(n) Position V2 record

positionsV2/{id}

GET Retrieve a(n) Position V2 record

PUT Update a(n) Position V2 record

DELETE Delete a(n) Position V2 record

positionsV2/activities

GET Search for Position Activity V2 records

PUT Update a(n) Position Activity V2 record

POST Create a(n) Position Activity V2 record

positionsV2/activities/{id}

GET Retrieve a(n) Position Activity V2 record

PUT Update a(n) Position Activity V2 record

DELETE Delete a(n) Position Activity V2 record

positionsV2/attachments

GET Search for Position Attachment records

PUT Update a(n) Position Attachment record

POST Create a(n) Position Attachment record

positionsV2/attachments/{id}

GET Retrieve a(n) Position Attachment record

PUT Update a(n) Position Attachment record

DELETE Delete a(n) Position Attachment record

positionsV2/customfields

GET Search for Position Field V2 records

PUT Update a(n) Position Field V2 record

POST Create a(n) Position Field V2 record

positionsV2/customfields/{id}

GET Retrieve a(n) Position Field V2 record

PUT Update a(n) Position Field V2 record

DELETE Delete a(n) Position Field V2 record

positionsV2/JobBoardLinks/{jobid}

GET Get links to job board for specified job

profile

GET Get the specific profile for the specified recordid, recordtype, profilename -or- profileid.

PUT Update profile for the specified Record

POST Adds new profile for the specified profile name

profile/{id}

PUT Update a(n) Profile record

DELETE Delete the specified profile for the supplied id.

profile/{ProfileId}

GET Get the specific profile for the specified recordid, recordtype, profilename -or- profileid.

DELETE Delete the specified profile for the supplied id.

profile/search

GET Get all profiles for the specified Record

profile/search/{RecordId}

GET Get all profiles for the specified Record

profile/template

GET Get the specific profile for the specified profile template name -or- profiletemplateid.

PUT Update the specific profile template for the specific profiletemplateid -or- profile template name

POST Adds a new profile template using the template name

profile/template/{id}

PUT Update a(n) Profile Template record

DELETE Delete the specified profile for the supplied id.

profile/template/{ProfileTemplateId}

GET Get the specific profile for the specified profile template name -or- profiletemplateid.

profile/template/{TemplateId}

DELETE Delete the specified profile for the supplied id.

profile/template/search

GET Get all profile templates

CandidatesV2/RollupLists

GET Search for Rollup Candidate V2 records

PUT Update a(n) Rollup Candidate V2 record

POST Create a(n) Rollup Candidate V2 record

CandidatesV2/RollupLists/{Code}/{CandidateId}

GET Get a Candidate Rollup Record by Rollup Code and Candidate ID

PUT PUT /CandidatesV2/RollupLists/{Code}/{CandidateId}

POST POST /CandidatesV2/RollupLists/{Code}/{CandidateId}

DELETE DELETE /CandidatesV2/RollupLists/{Code}/{CandidateId}

CandidatesV2/RollupLists/{id}

GET Retrieve a(n) Rollup Candidate V2 record

PUT Update a(n) Rollup Candidate V2 record

DELETE Delete a(n) Rollup Candidate V2 record

CompaniesV2/RollupLists

GET Search for Rollup Company V2 records

PUT Update a(n) Rollup Company V2 record

POST Create a(n) Rollup Company V2 record

CompaniesV2/RollupLists/{Code}/{CompanyId}

GET Get a Company Rollup Record by Rollup Code and Company ID

PUT PUT /CompaniesV2/RollupLists/{Code}/{CompanyId}

POST POST /CompaniesV2/RollupLists/{Code}/{CompanyId}

DELETE DELETE /CompaniesV2/RollupLists/{Code}/{CompanyId}

CompaniesV2/RollupLists/{id}

GET Retrieve a(n) Rollup Company V2 record

PUT Update a(n) Rollup Company V2 record

DELETE Delete a(n) Rollup Company V2 record

PositionsV2/RollupLists

GET Search for Rollup Position V2 records

PUT Update a(n) Rollup Position V2 record

POST Create a(n) Rollup Position V2 record

PositionsV2/RollupLists/{Code}/{JobId}

GET Get a Position Rollup Record by Rollup Code and Position ID

PUT PUT /PositionsV2/RollupLists/{Code}/{JobId}

POST POST /PositionsV2/RollupLists/{Code}/{JobId}

DELETE DELETE /PositionsV2/RollupLists/{Code}/{JobId}

PositionsV2/RollupLists/{id}

GET Retrieve a(n) Rollup Position V2 record

PUT Update a(n) Rollup Position V2 record

DELETE Delete a(n) Rollup Position V2 record

RollupListsV2

GET Search for Rollup List V2 records

PUT Update a(n) Rollup List V2 record

POST Create a(n) Rollup List V2 record

RollupListsV2/{id}

GET Retrieve a(n) Rollup List V2 record

PUT Update a(n) Rollup List V2 record

DELETE Delete a(n) Rollup List V2 record

RollupListsV2/{RollupCode}

GET Retrieve a(n) Rollup List V2 record

PUT Update a(n) Rollup List V2 record

DELETE Delete a(n) Rollup List V2 record

RollupListsV2/{RollupCode}/{UpdateRecentlyViewed}

GET Retrieve a(n) [Controller] record

RollupListsV2/{RollupType}/{RollupCode}/configuration

GET Get rollup configuration by rollup code

RollupListsV2/{RollupType}/{RollupCode}/stageicons

GET Get rollup stage icons by rollup code

RollupListsV2/globalStageTemplates

GET Retrieve the list of global stage templates for Rollup Lists

system

system/{codetype}/categories

GET Get categories of codes by type

system/{recordtype}/customfields

GET Search custom field list by record type

system/{recordtype}/customfields/{id}

GET Get custom field by ID

system/activitytypes

GET Search activity type list

system/activitytypes/{id}

GET Get activity by ID

system/customfields

GET Search all custom fields

system/customfields/{id}

GET Get custom field by ID

system/diversitysources

GET Search diversity sources

system/diversitysources/{id}

GET Get diversity sources by ID

system/educationcodes

GET Search education code list

system/educationcodes/{id}

GET Get education code by ID

system/emailsignature

GET Get email signature

PUT Set email signature

DELETE Delete email signature

system/equipmentcodes

GET Search equipment code list

system/insertfields/{type}

GET Get name insert field by Type

system/InterviewTypeDef

GET Get Pipeline Interview Status Definitions

system/siccodes

GET Search SIC code list

system/skillcodes

GET Search skill code list

system/specialty

GET Search specialty list

system/specialty/{id}

GET Get specialty by ID

system/titles

GET Search title list

system/titles/{id}

GET Get title by ID

system/userdefinedcodes

GET Search user defined code list

users

GET Search User Records

users/{id}

GET Get User by Username

users/{Username}

GET Get User by Username

users/{Username}/EmailAliases

GET Get user email aliases.

users/all-users

GET Get All User Records

users/EmailAliases

GET Get user email aliases.

users/resumes/{restype}

GET Get Resume Header for logged in user

PUT Update Resume Header/Footer

DELETE Delete Resume Header/Footer

Retrieve a valid API session

GET

https://www2.pcrecruiter.net/rest/api/access-token

Authorizations

Bearer

Please create a SessionId using the access-token endpoint and enter it here.

TypeHTTP (bearer)

Responses

Content-Type

application/json

JSON

{

"SessionId": "string",

"Login": "string",

"WebToken": "string",

"ControlsVersion": "string",

"CssVersion": "string",

"UID": "string"

}

GET

https://www2.pcrecruiter.net/rest/api/access-token

Playground

Authorization

Bearer

Variables

Key

Value

Username*

Password*

DatabaseId*

SessionId

ApiKey*

AppId*

PrivateApiToken

TwoFactorMethod

TwoFactorCode

RememberDevice

OauthState

NewOauthLogins

TokenLifespanMinutes

baseurl

Samples

Pager

Next pageWelcome to the PCRecruiter API Docs