Quick Start Guide 🚀

To get started with the PCRecruiter REST API, you will need access to an API key and APP ID. You can use the link here to sign up for API access: API Interest Form

Upon completing the sign up process the account will need to be approved before use. Once your request has been approved, you will be provided with your API key and APP ID for use with the PCRecruiter REST API. Check our website for more general API information: Developer API Page.

How will you use the API?

Developing a Custom Application

For job boards or custom apps tailored to a specific PCR client:

1. The client provides you with:
   • Login credentials
   • Database ID

Developing Third-Party Integrations

To create integrations for multiple PCR clients:

1. Contact support for further details and sandbox environment.

If it is your first time using our REST API, please read all of the articles found in this Quick Start Guide section and our Additional References articles, otherwise just visit the API References Section to see what is currently available in the API.

Authentication

The PCRecruiter REST API uses the access-token endpoint to generate a session. This session ID is required as a BEARER token in the Authorization header for subsequent calls.

Required Parameters:

• Username: PCRecruiter database username.
• Password: Corresponding password.
• DatabaseId: Provided by the PCRecruiter user.
• ApiKey: Can be retrieved after signing up to use the PCRecruiter API.
• AppId: Can be retrieved after signing up to use the PCRecruiter API.

Example:

POST /rest/api/access-token
{
  "Username": "{Username}",
  "Password": "***********",
  "DatabaseId": "{DatabaseId}",
  "ApiKey":"{API Key}",
  "AppId":"{App ID}"
}

With this information, you can execute a POST call to the access-token endpoint. You will find your session id in the response body.

TIP

Having trouble finding the DatabaseId? Log in to PCRecruiter, then navigate to System > API > API Settings to view it.

WARNING

API calls reflect changes in your supplied database. Be cautious when using PUT, POST, or DELETE calls during testing.

How our documentation works

API References

The API References section includes:

• All available API endpoints and supported methods.
• Parameter details and expected data types.
• Interactive features: Test endpoints directly or copy code snippets in multiple languages.

Additional References

The Additional References section provides:

• In-depth information on endpoint data and usage.
• Parameter explanations with practical example calls.