Welcome to the PCRecruiter API Docs! 🎉

This documentation covers everything you need to know about the PCRecruiter REST API. Read below to learn more about REST APIs. If you're already familiar with REST APIs, feel free to jump to our Quick Start Guide.

What is an API?

API stands for "Application Programming Interface." An API allows you to build products or services that interact with PCRecruiter without having to learn our codebase or how it is implemented. APIs allows businesses and partners to collaborate to build better integrated products. This allows us to open access to our software and resources without sacrificing security and control.

You can rely on our API to provide a seamless PCRecruiter experience as our own application utilizes the same API endpoints extensively.

What is REST?

REST "Representational State Transfer" is a type of API that allows you to send requests and receive responses from PCRecruiter using HTTP requests. Our REST API accepts JSON and XML formatted requests and can deliver responses back in the same two formats as well. This REST API format allows us to send responses that are uniform and consistent, meaning you will always know how our response is formatted and structured for a specific endpoint.

What is an Endpoint?

Endpoints are URIs "Uniform Resource Indices" on an API that an application can access. These can be used to request different information for each HTTP request. For example, we have candidate records as a set of data in PCRecruiter. Candidates have their own endpoint used to retrieve data about that specific set of data.

Supported HTTP Methods

PCRecruiter's makes use of or plans to make use of the following http methods in the REST web service.

Additional implementation information can be found with each resource as to what methods are supported for that item. For the initial release we are only allowing data to be read through GET requests with functionality to update, create, or remove data on its way in upcoming releases.

• POST - Use of this method will tell the web service to CREATE a new record.

• GET - Use of this method will tell the web service to READ data for a record or multiple records.

• PUT - Use of this method will tell the web service to UPDATE a record.

• DELETE - Use of this method will tell the web service to DELETE a record.