PCRecruiter API
Search... K

Appearance

Search References ​

By default, our Endpoints will return all records if a specific ID is not supplied. You can also add a query to the request to narrow your results to the desired records. Read below to learn more about how querying works with our API.

Relational Operators ​

The following relational operators are supported when using the query parameter in a GET request:

  • eq (equal)
  • ne (not equal)
  • gt (greater-than)
  • lt (less-than)
  • ge (greater-than-equal)
  • le (less-than-equal)
  • sw (starts with)
  • ew (ends with)
  • co (contains)

Below are some samples of simple queries using the various operators:

Equal ​

Find all name records with a status equal to "candidate":

../candidates?query=status eq candidate

Greater-than-equal ​

Find all name records entered greater-than or equal to a specified date:

../candidates?query=DateEntered ge 2013-01-01T10:07:40.840

Starts-with ​

Find all name records where the title starts with "sales":

../candidates?query=Title sw sales

Contains ​

Find all name records where the title contains "manager":

../candidates?query=Title co manager

Logical Operators ​

The following logical operators are supported when using the query parameter in a GET request:

  • AND
  • OR

AND ​

Combine multiple conditions with AND:

../candidates?query=status eq candidate AND title sw sales

OR ​

Combine multiple conditions with OR:

../candidates?query=status eq candidate OR status eq unverified

Grouping ​

Grouping in queries is done with parentheses. When used for grouping, parentheses only need to be URL-encoded if necessary. Example:

../candidates?query=status eq candidate AND (state eq ohio OR state eq new york)

Finding Records on a Rollup List ​

To search for all of the names on a rollup list in PCRecruiter, include the Rollup field name followed by the value in the query parameter. Initially, these values will need to be supplied by the client from the PCR database. Example:

../candidates?query=Rollup eq ADMIN.0002

Special Cases ​

If a search contains a field or value that is one of the logical operators, it should be escaped with a backslash (\). Example 1: Searching for State equals "Oregon" (OR as part of the state name)

../candidates?query=State eq \OR

Example 2: Searching for a Company with AND in the company name

../candidates?query=CompanyName eq Smith \AND Smith