POST api/v3/Candidate/List

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FirstName	string	None.
LastName	string	None.
CampaignId	string	None.
CandidateCampaignStatusId	string	None.
isRejected	boolean	None.
isShortlist	boolean	None.
AddedSince	date	None.
NonReviewedCVs	boolean	None.
NonReviewedContent	boolean	None.
OpinionRequested	boolean	None.
CVKeywordPercentage	string	None.
ScoringMatrix	string	None.
SortBy	string	None.
CampaignCandidateIds	string	None.
CVKeyword	string	None.

Request Formats

application/json, text/json

Sample:

{
  "firstName": "sample string 1",
  "lastName": "sample string 2",
  "campaignId": "sample string 3",
  "candidateCampaignStatusId": "sample string 4",
  "isRejected": true,
  "isShortlist": true,
  "addedSince": "2025-12-06T04:39:48.6275374+00:00",
  "nonReviewedCVs": true,
  "nonReviewedContent": true,
  "opinionRequested": true,
  "cvKeywordPercentage": "sample string 5",
  "scoringMatrix": "sample string 6",
  "sortBy": "sample string 7",
  "campaignCandidateIds": "sample string 8",
  "cvKeyword": "sample string 9"
}

text/html

Sample:

{"firstName":"sample string 1","lastName":"sample string 2","campaignId":"sample string 3","candidateCampaignStatusId":"sample string 4","isRejected":true,"isShortlist":true,"addedSince":"2025-12-06T04:39:48.6275374+00:00","nonReviewedCVs":true,"nonReviewedContent":true,"opinionRequested":true,"cvKeywordPercentage":"sample string 5","scoringMatrix":"sample string 6","sortBy":"sample string 7","campaignCandidateIds":"sample string 8","cvKeyword":"sample string 9"}

application/xml, text/xml

Sample:

<CandidateListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IC_Web_API_V3.Models">
  <AddedSince>2025-12-06T04:39:48.6275374+00:00</AddedSince>
  <CVKeyword>sample string 9</CVKeyword>
  <CVKeywordPercentage>sample string 5</CVKeywordPercentage>
  <CampaignCandidateIds>sample string 8</CampaignCandidateIds>
  <CampaignId>sample string 3</CampaignId>
  <CandidateCampaignStatusId>sample string 4</CandidateCampaignStatusId>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <NonReviewedCVs>true</NonReviewedCVs>
  <NonReviewedContent>true</NonReviewedContent>
  <OpinionRequested>true</OpinionRequested>
  <ScoringMatrix>sample string 6</ScoringMatrix>
  <SortBy>sample string 7</SortBy>
  <isRejected>true</isRejected>
  <isShortlist>true</isShortlist>
</CandidateListRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CandidateListRequest'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.