PCRecruiter API
Search... K

Appearance

Candidates V2 ​

Description ​

The candidatesv2 endpoint is used to manage candidate records in PCRecruiter. You can retrieve, create, update, and delete records using standard REST operations.

Base Operations ​

These operations work with the main candidatesv2 records.

GET - Search for Candidate V2 records

POST - Create a(n) Candidate V2 record

PUT - Update a(n) Candidate V2 record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • CandidateId (integer,null, int64) -
  • ReplicationId (string) -
  • CompanyId (integer,null, int64) -
  • FirstName (string) -
  • LastName (string) -
  • MiddleInitial (string) -
  • Salutation (string) -
  • Title (string) -
  • Address (string) -
  • Address2 (string) -
  • City (string) -
  • State (string) -
  • PostalCode (string) -
  • PostalCodeExtension (string) -
  • FullPostalCode (string) -
  • County (string) -
  • Country (string) -
  • HomePhone (string) -
  • FaxPhone (string) -
  • Pager (string) -
  • MobilePhone (string) -
  • WorkPhone (string) -
  • CurrentOccupation (string) -
  • Relocate (string) -
  • CurrentSalary -
  • DesiredSalary -
  • School (string) -
  • DegreeType (string) -
  • GradYear (string) -
  • DateEntered (null,string, date-time) -
  • EmailAddress (string) -
  • Industry (string) -
  • Specialty (string) -
  • ShowOnWebRollup (string) -
  • Status -
  • Subjective (integer,null, int32) -
  • HasResume (boolean,null) -
  • Keywords (string) -
  • Notes (string) -
  • Identification (string) -
  • LastActivity (null,string, date-time) -
  • LastModified (null,string, date-time) -
  • Available (null,string, date-time) -
  • BillRate -
  • PayRate -
  • DefaultCurrency -
  • UserName (string) -
  • Photograph (string, byte) -
  • PhotographThumb (string, byte) -
  • Group -
  • HasNotes (boolean,null) -
  • Summary (string) -
  • ResumeText (string) -
  • PrivateNotes (string) -
  • CustomFields (array) -
  • EEOC (array) -
  • Activities (array) -
  • RollupLists (array) -
  • Company -
  • Education (array) -
  • WorkHistory (array) -
  • Licensing (array) -
  • References (array) -
  • Military (array) -
  • Resumes (array) -
  • Feedback (array) -
  • Interviews (array) -
  • Attachments (array) -
  • Recipients (array) -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/?Query=FirstName eq Jane&Fields=CandidateId,ReplicationId,CompanyId,FirstName,LastName,MiddleInitial",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "TotalRecords": 25,
  "Results": [
    {
      "CandidateId": null,
      "ReplicationId": "Sample Text",
      "CompanyId": 12345,
      "FirstName": "Jane",
      "LastName": "Smith",
      "MiddleInitial": "Sample Text"
    },
    {
      "CandidateId": null,
      "ReplicationId": "Sample Text",
      "CompanyId": 12345,
      "FirstName": "Jane",
      "LastName": "Smith",
      "MiddleInitial": "Sample Text"
    }
  ]
}

TIP

This API call returns a paginated list of records. Use Query parameter to filter results, Page and ResultsPerPage to control pagination, and Order to sort results.

------------------ REQUEST ------------------- ​
json
{
  "method": "POST",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "CompanyId": 130675937475340,
    "FirstName": "Jane",
    "LastName": "Smith",
    "MiddleInitial": "",
    "Salutation": "",
    "Title": "Sample Title",
    "Address": "123 Sample Address",
    "Address2": null,
    "City": "Cleveland",
    "State": "OH",
    "PostalCode": "44060 - 2342",
    "PostalCodeExtension": null,
    "FullPostalCode": "44060 - 2342",
    "County": "Lake",
    "Country": "US",
    "HomePhone": "",
    "FaxPhone": "",
    "Pager": null,
    "MobilePhone": "(555) 555-5555",
    "WorkPhone": "(440) 946-5214",
    "CurrentOccupation": null,
    "Relocate": null,
    "CurrentSalary": {
        "CurrencyCode": "USD",
        "Value": 1.00
    },
    "DesiredSalary": {
        "CurrencyCode": "USD",
        "Value": 1.00
    },
    "School": null,
    "DegreeType": null,
    "GradYear": "2000",
    "DateEntered": "2018-12-05T16:52:15",
    "EmailAddress": "jane.smith@example.com",
    "Industry": "Computer Software",
    "Specialty": "",
    "ShowOnWebRollup": null,
    "Status": "ContractorTemp",
    "Subjective": 1,
    "HasResume": true,
    "Identification": "123456",
    "LastActivity": "2025-10-01T11:21:15",
    "LastModified": "2025-10-01T11:21:15",
    "Available": null,
    "BillRate": null,
    "PayRate": {
        "CurrencyCode": "USD",
        "Value": 1.00
    },
    "DefaultCurrency": "USD",
    "UserName": "SAMPLE",
    "Group": "Group1",
    "CustomFields": []
}
}
------------------ RESPONSE ------------------ ​
json
{
  "CandidateId": 119091786499037,
}

TIP

This API call creates a new record. Include the required fields in the request body. The response will contain the created record with its newly assigned ID. If you do not supply a CompanyId, the record will be added to the default company

PUT - Update a(n) Candidate V2 record

GET - Retrieve a(n) Candidate V2 record

DELETE - Delete a(n) Candidate V2 record

Data Parameters ​

  • Success (boolean) -
  • Message (string) -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/{id}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "CandidateId": 119091786499037,
    "CompanyId": 130675937475340,
    "FirstName": "Jane",
    "LastName": "Smith",
    "MiddleInitial": "",
    "Salutation": "",
    "Title": "Sample Title",
    "Address": "123 Sample Address",
    "Address2": null,
    "City": "Cleveland",
    "State": "OH",
    "PostalCode": "44060 - 2342",
    "PostalCodeExtension": null,
    "FullPostalCode": "44060 - 2342",
    "County": "Lake",
    "Country": "US",
    "HomePhone": "",
    "FaxPhone": "",
    "Pager": null,
    "MobilePhone": "(555) 555-5555",
    "WorkPhone": "(440) 946-5214",
    "CurrentOccupation": null,
    "Relocate": null,
    "CurrentSalary": {
        "CurrencyCode": "USD",
        "Value": 1.00
    },
    "DesiredSalary": {
        "CurrencyCode": "USD",
        "Value": 1.00
    },
    "School": null,
    "DegreeType": null,
    "GradYear": "2000",
    "DateEntered": "2018-12-05T16:52:15",
    "EmailAddress": "jane.smith@example.com",
    "Industry": "Computer Software",
    "Specialty": "",
    "ShowOnWebRollup": null,
    "Status": "ContractorTemp",
    "Subjective": 1,
    "HasResume": true,
    "Identification": "123456",
    "LastActivity": "2025-10-01T11:21:15",
    "LastModified": "2025-10-01T11:21:15",
    "Available": null,
    "BillRate": null,
    "PayRate": {
        "CurrencyCode": "USD",
        "Value": 1.00
    },
    "DefaultCurrency": "USD",
    "UserName": "SAMPLE",
    "Group": "Group1",
    "CustomFields": []
}

TIP

This API call retrieves a specific record by its ID. Use query parameters like Fields, FieldsPlus to control which fields are returned in the response.

------------------ REQUEST ------------------- ​
json
{
  "method": "PUT",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/{id}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "CandidateId": null,
    "ReplicationId": "Sample Text",
    "CompanyId": 12345
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "Success": true
}

TIP

This API call updates an existing record. Include the fields you want to modify in the request body. Only the provided fields will be updated.

------------------ REQUEST ------------------- ​
json
{
  "method": "DELETE",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/123456",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "Success": true
}

TIP

This API call permanently deletes the specified record. This action cannot be undone.

Activities ​

Manage activities data associated with candidatesv2 records.

GET - Search for Candidate Activity V2 records

POST - Create a(n) Candidate Activity V2 record

PUT - Update a(n) Candidate Activity V2 record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • ActivityId (integer,null, int64) -
  • CandidateId (integer,null, int64) -
  • UserName (string) -
  • DateEntered (null,string, date-time) -
  • Memo (string) -
  • ActType (string) -
  • Result (string) -
  • FormId (integer,null, int64) -
  • Candidate -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/activities/{Activityid}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
{
"ActivityId": 100000130614268,
"CandidateId": 224567490940051,
"UserName": "SAMPLE",
"DateEntered": "2024-12-30T22:04:13",
"Memo": "This is a sample of Activity Text",
"ActType": "EMAIL",
"Result": null
}
}

TIP

This API call returns one activity record matching the ActivityId supplied.

------------------ REQUEST ------------------- ​
json
{
  "method": "POST",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/activities/",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "CandidateId": 224567490940051,
    "UserName": "SAMPLE",
    "Memo": "This is some sample Activity Text",
    "ActType": "EMAIL",
  }
}
------------------ RESPONSE ------------------ ​
json
{
"ActivityId": 697764971197453
}

TIP

This API call creates a new activity record for the candidate supplied in the CandidateId. Include the required fields in the request body. The response will contain the created record with its newly assigned ID.

------------------ REQUEST ------------------- ​
json
{
  "method": "PUT",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/activities/{ActivityId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "UserName": "ADMIN"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "Success": true
}

TIP

This API call updates an existing record. Include the fields you want to modify in the request body. Only the provided fields will be updated.

GET - Retrieve a(n) Candidate Activity V2 record

PUT - Update a(n) Candidate Activity V2 record

DELETE - Delete a(n) Candidate Activity V2 record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • ActivityId (integer,null, int64) -
  • CandidateId (integer,null, int64) -
  • UserName (string) -
  • DateEntered (null,string, date-time) -
  • Memo (string) -
  • ActType (string) -
  • Result (string) -
  • FormId (integer,null, int64) -
  • Candidate -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/activities?Query=CandidateId eq 224567490940051",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "TotalRecords": 2,
    "Results": [
        {
            "ActivityId": 100000130614268,
            "CandidateId": 224567490940051,
            "UserName": "SAMPLE",
            "DateEntered": "2024-12-30T22:04:13",
            "Memo": "This is some sample Activity Text",
            "ActType": "PHONE",
            "Result": null
        },
        {
            "ActivityId": 100004372145160,
            "CandidateId": 224567490940051,
            "UserName": "SAMPLE",
            "DateEntered": "2022-03-31T18:00:29",
            "Memo": "This is some sample Activity Text",
            "Result": null
        }
    ]
}

TIP

This API call retrieves all activities for a specific record by its ID supplied in the query.

------------------ REQUEST ------------------- ​
json
{
  "method": "DELETE",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/activities/123456",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "Success": true
}

TIP

This API call permanently deletes the specified activity record. This action cannot be undone.

Attachments ​

Manage attachments data associated with candidatesv2 records.

GET - Search for Candidate Attachment records

POST - Create a(n) Candidate Attachment record

PUT - Update a(n) Candidate Attachment record

Data Parameters ​

  • AttachmentId (integer,null, int64) -
  • Type -
  • Name (string) -
  • Description (string) -
  • Date (null,string, date-time) -
  • ProfileLink (string) -
  • ProfileLinkEdit (string) -
  • Hash (string) -
  • Data (string, byte) -
  • Size (integer,null, int64) -
  • TokenId (integer,null, int64) -
  • AggregateCount (integer,null, int32) -
  • MetaData -
  • CandidateId (integer,null, int64) -
  • Candidate -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/attachments?Query=CandidateId eq 224567490940051",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "TotalRecords": 4,
    "Results": [
        {
            "CandidateId": 224567490940051,
            "AttachmentId": 121439684142156,
            "Type": "PROFILE",
            "Name": "Sample Profile1",
            "Description": "This is a sample Profile",
            "Date": "2025-06-05T16:55:39.717",
            "Size": 517
        },
        {
            "CandidateId": 224567490940051,
            "AttachmentId": 134093390333220,
            "Type": "PROFILE",
            "Name": "Capture LinkedIn profile",
            "Description": "Capture LinkedIn profile",
            "Date": "2025-04-14T17:45:08.29",
            "Size": 68443
        },
        {
            "CandidateId": 224567490940051,
            "AttachmentId": 254959775911256,
            "Type": "UPLOAD",
            "Name": "photo.jpg",
            "Description": "Uploaded Photograph",
            "Date": "2025-04-14T17:45:30.247",
            "Size": 7335
        },
        {
            "CandidateId": 224567490940051,
            "AttachmentId": 763429557773138,
            "Type": "UPLOAD",
            "Name": "Resume.txt",
            "Description": "Current Word Resume",
            "Date": "2025-10-02T11:45:31.033",
            "Size": 5720
        }
    ]
}

TIP

This API call returns all of the attachments for the CandidateId supplied in the query.

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/attachments/{AttachmentId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
"CandidateId": 224567490940051,
"AttachmentId": 254959775911256,
"Type": "UPLOAD",
"Name": "photo.jpg",
"Description": "Uploaded Photograph",
"Date": "2025-04-14T17:45:30.247",
"Size": 7335
}

TIP

This API call retrieves the attachment for the supplied AttachmentId

------------------ REQUEST ------------------- ​
json
{
  "method": "DELETE",
  "url": "https://www2.pcrecruiter.net/rest/api/candidatesV2/attachments/123456",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "Success": true
}

TIP

This API call permanently deletes the specified record. This action cannot be undone.

Rolluplists ​

Manage rolluplists data associated with candidatesv2 records.

GET - Search for Rollup Candidate V2 records

POST - Create a(n) Rollup Candidate V2 record

PUT - Update a(n) Rollup Candidate V2 record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • CandidateId (integer,null, int64) -
  • Code (string) -
  • Stage -
  • Rank (integer,null, int32) -
  • Comments (string) -
  • DateEntered (null,string, date-time) -
  • LastModified (null,string, date-time) -
  • DateRead (null,string, date-time) -
  • SortDistance (null,number, double) -
  • Candidate -
  • RollupList -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/CandidatesV2/RollupLists?Query=CandidateId eq 119091786499037",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "TotalRecords": 2,
    "Results": [
        {
            "CandidateId": 119091786499037,
            "Code": "SAMPLE.0006",
            "Stage": "None",
            "Rank": 0,
            "Comments": null,
            "DateEntered": "2020-07-17T16:01:47",
            "LastModified": null
        },
        {
            "CandidateId": 119091786499037,
            "Code": "SAMPLE.0017",
            "Stage": "None",
            "Rank": 0,
            "Comments": null,
            "DateEntered": "2023-10-17T04:53:19.323",
            "LastModified": null
        }
    ]
}

TIP

This API call returns a list of Rollups that the supplied CandidateId is associated with. Use Query parameter to filter results, Page and ResultsPerPage to control pagination, and Order to sort results.

------------------ REQUEST ------------------- ​
json
{
  "method": "POST",
  "url": "https://www2.pcrecruiter.net/rest/api/CandidatesV2/RollupLists/",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "CandidateId": 119091786499037,
    "Code": "SAMPLE.0018"
  }
}
------------------ RESPONSE ------------------ ​
json
{
"CandidateId": 119091786499037,
"Code": "SAMPLE.0018"
}

TIP

This API call associates the supplied CandidateId with the supplied Rollup Code. This does not create a new Rollup record and only acts to associate the records and add the candidate to the Rollup list.