PCRecruiter API
Search... K

Appearance

System ​

The system endpoint is a GET-only endpoint used to retrieve system information within PCRecruiter. Although this endpoint is not typically a direct component of integrations, it is invaluable for identifying system settings and values that can be incorporated into integration workflows. These include information about custom fields, activity types, diversity sources, and education codes.

Custom Fields ​

Custom fields are user-created fields for names, companies, and positions. These fields allow users to track data that is not natively available within PCRecruiter, making them essential for customized workflows. This endpoint retrieves the field definitions (metadata) for custom fields — the field names, types, ordering, and available dropdown values — not the actual data stored in those fields on individual records.

To retrieve custom field values for a specific record, use the CustomFields property on the record endpoint (e.g., GET /candidates/{id}?Fields=CustomFields). To search for records by custom field values, use the query parameter on the record endpoint (e.g., GET /candidates?query=FieldName eq Value).

Data parameters ​

  • CustomId: The unique identifier for the custom field.
  • FieldType: Specifies the record type this field is associated with (e.g., "FieldType": "Candidates").
  • FieldName: The user-defined name of the custom field (e.g., "FieldName": "Recruiting Priority").
  • FieldOrder: Determines the field's position in the custom fields list.
  • FieldAction: Describes the field type (e.g., dropdown, multi-select, URL, email, phone).
  • DefaultValues: Provides preset options for dropdown or multi-select field types:
    • Id: Identifier for the default value (e.g., "Id": 30).
    • Name: Name of the default value (e.g., "Name": "High Priority").
    • Order: The sequence in which this value appears.

Examples ​

------------------ REQUEST ------------------- ​
API
GET /rest/api/system/candidates/customfields
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/system/Candidates/CustomFields",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "TotalRecords": 2,
  "Results": [
    {
      "CustomId": 12345,
      "FieldType": "Candidates",
      "FieldName": "Recruiting Priority",
      "FieldOrder": 2,
      "FieldAction": "MultiSelectCheckbox",
      "DefaultValues": [
        { "Id": 30, "Name": "High Priority", "Order": 1 },
        { "Id": 31, "Name": "Medium Priority", "Order": 2 },
        { "Id": 32, "Name": "Low Priority", "Order": 3 }
      ]
    },
    {
      "CustomId": 12346,
      "FieldType": "Candidates",
      "FieldName": "Custom Phone Field",
      "FieldOrder": 4,
      "FieldAction": "Phone",
      "DefaultValues": [{ "Id": 0, "Name": null, "Order": 0 }]
    }
  ]
}

TIP

Use this API call to retrieve all custom fields associated with the candidate record type. Leverage these fields in other API calls for advanced customization and tracking.

Activity Types ​

Activity types are predefined values used to log activities within PCRecruiter. Using standardized types enhances reporting and analytics accuracy. These types can be applied to names, companies, and positions.

Data parameters ​

  • ActivityId: The unique identifier for the activity type.
  • Code: The activity type value used in the activity section (e.g., "Code": "NOSHOW").
  • Description: A brief explanation of the activity type (e.g., "Description": "Candidate missed scheduled call").
  • Category: Groups activity types within the system menu (optional).

Examples ​

------------------ REQUEST ------------------- ​
API
GET /rest/api/system/activitytypes
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/System/ActivityTypes",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "TotalRecords": 2,
  "Results": [
    {
      "ActivityId": 101,
      "Code": "NOSHOW",
      "Description": "Did not show for candidate call",
      "Category": null
    },
    {
      "ActivityId": 102,
      "Code": "BREAK",
      "Description": "Taking a break from the candidate search",
      "Category": null
    }
  ]
}

TIP

Activity types are universal and can be applied to names, companies, and positions in the database.

Diversity Sources ​

Diversity sources track how candidates entered PCRecruiter, enabling users to analyze recruitment channels like websites, job boards, and external referrals.

Data parameters ​

  • DiversitySourceId: Unique identifier for the source.
  • Source: Name of the source (e.g., "Source": "LinkedIn").
  • Contact: Name of the person associated with the source.
  • Address: Contact's address.
  • Phone: Contact's phone number.
  • Vacant: Boolean indicating if the contact is notified of open vacancies.
  • Code: Abbreviated code for the source name.
  • Show: Determines visibility in PCRecruiter web extensions (0 = Show, 1 = Internal Only).

Examples ​

------------------ REQUEST ------------------- ​
API
GET /rest/api/system/diversitysources/{DiversitySourceId}
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/System/DiversitySources/{DiversitySourceId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "DiversitySourceId": 301,
  "Source": "LinkedIn",
  "Contact": "Sample Contact",
  "Address": "4420 Sherwin Rd",
  "Phone": "(440) 946-5214",
  "Vacant": true,
  "Code": null,
  "Show": "1"
}

TIP

Retrieve all diversity sources by omitting the DiversitySourceId from the API call.

Education Codes ​

Education codes allow users to classify keywords linked to candidate education qualifications, providing an alternative to resume or education history sections.

Data parameters ​

  • EducationId: Unique identifier for the education code.
  • Code: Short identifier for the education qualification (e.g., "Code": "PHD").
  • Description: A detailed explanation of the code (e.g., "Description": "Doctor of Philosophy").
  • Category: Groups education codes within the system menu.

Examples ​

------------------ REQUEST ------------------- ​
API
GET /rest/api/system/educationcodes
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/System/EducationCodes",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "TotalRecords": 1,
  "Results": [
    {
      "EducationId": 501,
      "Code": "PHD",
      "Description": "Doctor of Philosophy",
      "Category": "0"
    }
  ]
}

TIP

Use this API call to retrieve all education codes in the database.