Endpoint References

The Endpoint References section below will let you explore a deep dive of the most common endpoints to learn how they function, why you might use them and what some of the parameters available mean.

These endpoint references will also provide example calls in each demonstration.

WARNING

Be cautious when trying API calls in this documentation, as they will affect the database tied to your session. Avoid testing calls like PUT, POST, or DELETE on production data to prevent unintended changes.

Authentication

The access-token endpoint generates a session ID that acts as a BEARER token for authorization in subsequent API calls.

Required Parameters:

• Username: PCRecruiter database username.
• Password: Corresponding password.
• DatabaseId: Provided by the PCRecruiter user.

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. Make sure to double-check this value before proceeding with API calls.