GET v3/JobCandidates


Documentation/Notes

Returns all candidates.


Request Information

Authorization required.

Need to send an authorized BDtoken under the Authorization header along with the call.


URI Parameters

NameDescriptionTypeAdditional information
disp

Hired. If no “Disp” filter is included, candidates of all dispositions and stages will be included.

string

None.

numdays

Number of days within current date the job candidate record was created

string

None.

status

Status of jobs to search, defaults to 'open'

string

None.

lastupdatedate

Last update date of job candidate. If end date is not supplied, will only compare jobs from the exact day

string

None.

lastupdateenddate

End date range to search for last update date

string

None.


Body Parameters

None.


Response Information

Resource Description

JobCandidatesListResultsModelOfATSJobCandidateV3Model
NameDescriptionTypeAdditional information
Candidates

Collection of ATSJobCandidateV3Model

None.

TotalCandidateCount

integer

None.

status

Sucessful, Error

string

None.

messages

Contains Error message if an error occured.

Collection of string

None.


Response Formats

application/json, text/json

Sample:
{
  "candidates": [
    {
      "accountName": "sample string 1",
      "accountId": 2,
      "reqNumber": "sample string 3",
      "jobId": 4,
      "jobTitle": "sample string 5",
      "onboardLocation": "sample string 6",
      "jobCity": "sample string 7",
      "jobState": "sample string 8",
      "jobCreateDate": "2021-10-26T15:11:53.2795258-05:00",
      "hiredDate": "2021-10-26T15:11:53.2795258-05:00",
      "startDate": "2021-10-26T15:11:53.2795258-05:00",
      "candidateId": 12,
      "jobCandidateId": 13,
      "jobSource": "sample string 14",
      "emailAddress": "sample string 15",
      "firstName": "sample string 16",
      "lastName": "sample string 17",
      "addressLine1": "sample string 18",
      "addressLine2": "sample string 19",
      "city": "sample string 20",
      "state": "sample string 21",
      "postalCode": "sample string 22",
      "mainPhone": "sample string 23",
      "altPhone1": "sample string 24",
      "altPhone2": "sample string 25",
      "facebookLink": "sample string 26",
      "linkedInLink": "sample string 27",
      "twitterLink": "sample string 28",
      "skypeLink": "sample string 29",
      "labels": "sample string 30",
      "customAppName": "sample string 31",
      "candStage": "sample string 32",
      "finalDisp": "sample string 33",
      "applyDate": "2021-10-26T15:11:53.2795258-05:00",
      "eeoCategory": "sample string 35",
      "gender": "sample string 36",
      "ethnicOrigin": "sample string 37",
      "veteranStatus": "sample string 38",
      "disabilityStatus": "sample string 39",
      "customFields": [
        {
          "fieldLabel": "sample string 1",
          "fieldValue": "sample string 2"
        },
        {
          "fieldLabel": "sample string 1",
          "fieldValue": "sample string 2"
        }
      ],
      "screeningQuestions": [
        {
          "question": "sample string 1",
          "answer": "sample string 2"
        },
        {
          "question": "sample string 1",
          "answer": "sample string 2"
        }
      ],
      "lastUpdateDate": "2021-10-26T15:11:53.2805262-05:00",
      "jobStatus": "sample string 41"
    },
    {
      "accountName": "sample string 1",
      "accountId": 2,
      "reqNumber": "sample string 3",
      "jobId": 4,
      "jobTitle": "sample string 5",
      "onboardLocation": "sample string 6",
      "jobCity": "sample string 7",
      "jobState": "sample string 8",
      "jobCreateDate": "2021-10-26T15:11:53.2795258-05:00",
      "hiredDate": "2021-10-26T15:11:53.2795258-05:00",
      "startDate": "2021-10-26T15:11:53.2795258-05:00",
      "candidateId": 12,
      "jobCandidateId": 13,
      "jobSource": "sample string 14",
      "emailAddress": "sample string 15",
      "firstName": "sample string 16",
      "lastName": "sample string 17",
      "addressLine1": "sample string 18",
      "addressLine2": "sample string 19",
      "city": "sample string 20",
      "state": "sample string 21",
      "postalCode": "sample string 22",
      "mainPhone": "sample string 23",
      "altPhone1": "sample string 24",
      "altPhone2": "sample string 25",
      "facebookLink": "sample string 26",
      "linkedInLink": "sample string 27",
      "twitterLink": "sample string 28",
      "skypeLink": "sample string 29",
      "labels": "sample string 30",
      "customAppName": "sample string 31",
      "candStage": "sample string 32",
      "finalDisp": "sample string 33",
      "applyDate": "2021-10-26T15:11:53.2795258-05:00",
      "eeoCategory": "sample string 35",
      "gender": "sample string 36",
      "ethnicOrigin": "sample string 37",
      "veteranStatus": "sample string 38",
      "disabilityStatus": "sample string 39",
      "customFields": [
        {
          "fieldLabel": "sample string 1",
          "fieldValue": "sample string 2"
        },
        {
          "fieldLabel": "sample string 1",
          "fieldValue": "sample string 2"
        }
      ],
      "screeningQuestions": [
        {
          "question": "sample string 1",
          "answer": "sample string 2"
        },
        {
          "question": "sample string 1",
          "answer": "sample string 2"
        }
      ],
      "lastUpdateDate": "2021-10-26T15:11:53.2805262-05:00",
      "jobStatus": "sample string 41"
    }
  ],
  "totalCandidateCount": 1,
  "status": "sample string 2",
  "messages": []
}

application/xml, text/xml

Sample:
<JobCandidatesListResultsModelOfATSJobCandidateV3Model2xqYqMbL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.V1">
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <status>sample string 2</status>
  <Candidates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.V3">
    <d2p1:ATSJobCandidateV3Model>
      <d2p1:AccountId>2</d2p1:AccountId>
      <d2p1:AccountName>sample string 1</d2p1:AccountName>
      <d2p1:AddressLine1>sample string 18</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 19</d2p1:AddressLine2>
      <d2p1:AltPhone1>sample string 24</d2p1:AltPhone1>
      <d2p1:AltPhone2>sample string 25</d2p1:AltPhone2>
      <d2p1:ApplyDate>2021-10-26T15:11:53.2795258-05:00</d2p1:ApplyDate>
      <d2p1:CandStage>sample string 32</d2p1:CandStage>
      <d2p1:CandidateId>12</d2p1:CandidateId>
      <d2p1:City>sample string 20</d2p1:City>
      <d2p1:CustomAppName>sample string 31</d2p1:CustomAppName>
      <d2p1:CustomFields xmlns:d4p1="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.ATSAPIModels">
        <d4p1:JobCustomPostingFieldModel>
          <d4p1:FieldLabel>sample string 1</d4p1:FieldLabel>
          <d4p1:FieldValue>sample string 2</d4p1:FieldValue>
        </d4p1:JobCustomPostingFieldModel>
        <d4p1:JobCustomPostingFieldModel>
          <d4p1:FieldLabel>sample string 1</d4p1:FieldLabel>
          <d4p1:FieldValue>sample string 2</d4p1:FieldValue>
        </d4p1:JobCustomPostingFieldModel>
      </d2p1:CustomFields>
      <d2p1:DisabilityStatus>sample string 39</d2p1:DisabilityStatus>
      <d2p1:EEOCategory>sample string 35</d2p1:EEOCategory>
      <d2p1:EmailAddress>sample string 15</d2p1:EmailAddress>
      <d2p1:EthnicOrigin>sample string 37</d2p1:EthnicOrigin>
      <d2p1:FacebookLink>sample string 26</d2p1:FacebookLink>
      <d2p1:FinalDisp>sample string 33</d2p1:FinalDisp>
      <d2p1:FirstName>sample string 16</d2p1:FirstName>
      <d2p1:Gender>sample string 36</d2p1:Gender>
      <d2p1:HiredDate>2021-10-26T15:11:53.2795258-05:00</d2p1:HiredDate>
      <d2p1:JobCandidateId>13</d2p1:JobCandidateId>
      <d2p1:JobCity>sample string 7</d2p1:JobCity>
      <d2p1:JobCreateDate>2021-10-26T15:11:53.2795258-05:00</d2p1:JobCreateDate>
      <d2p1:JobId>4</d2p1:JobId>
      <d2p1:JobSource>sample string 14</d2p1:JobSource>
      <d2p1:JobState>sample string 8</d2p1:JobState>
      <d2p1:JobStatus>sample string 41</d2p1:JobStatus>
      <d2p1:JobTitle>sample string 5</d2p1:JobTitle>
      <d2p1:Labels>sample string 30</d2p1:Labels>
      <d2p1:LastName>sample string 17</d2p1:LastName>
      <d2p1:LastUpdateDate>2021-10-26T15:11:53.2805262-05:00</d2p1:LastUpdateDate>
      <d2p1:LinkedInLink>sample string 27</d2p1:LinkedInLink>
      <d2p1:MainPhone>sample string 23</d2p1:MainPhone>
      <d2p1:OnboardLocation>sample string 6</d2p1:OnboardLocation>
      <d2p1:PostalCode>sample string 22</d2p1:PostalCode>
      <d2p1:ReqNumber>sample string 3</d2p1:ReqNumber>
      <d2p1:ScreeningQuestions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.ATSAPIModels">
        <d4p1:JobScreeningQuestionModel>
          <d4p1:Answer>sample string 2</d4p1:Answer>
          <d4p1:Question>sample string 1</d4p1:Question>
        </d4p1:JobScreeningQuestionModel>
        <d4p1:JobScreeningQuestionModel>
          <d4p1:Answer>sample string 2</d4p1:Answer>
          <d4p1:Question>sample string 1</d4p1:Question>
        </d4p1:JobScreeningQuestionModel>
      </d2p1:ScreeningQuestions>
      <d2p1:SkypeLink>sample string 29</d2p1:SkypeLink>
      <d2p1:StartDate>2021-10-26T15:11:53.2795258-05:00</d2p1:StartDate>
      <d2p1:State>sample string 21</d2p1:State>
      <d2p1:TwitterLink>sample string 28</d2p1:TwitterLink>
      <d2p1:VeteranStatus>sample string 38</d2p1:VeteranStatus>
    </d2p1:ATSJobCandidateV3Model>
    <d2p1:ATSJobCandidateV3Model>
      <d2p1:AccountId>2</d2p1:AccountId>
      <d2p1:AccountName>sample string 1</d2p1:AccountName>
      <d2p1:AddressLine1>sample string 18</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 19</d2p1:AddressLine2>
      <d2p1:AltPhone1>sample string 24</d2p1:AltPhone1>
      <d2p1:AltPhone2>sample string 25</d2p1:AltPhone2>
      <d2p1:ApplyDate>2021-10-26T15:11:53.2795258-05:00</d2p1:ApplyDate>
      <d2p1:CandStage>sample string 32</d2p1:CandStage>
      <d2p1:CandidateId>12</d2p1:CandidateId>
      <d2p1:City>sample string 20</d2p1:City>
      <d2p1:CustomAppName>sample string 31</d2p1:CustomAppName>
      <d2p1:CustomFields xmlns:d4p1="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.ATSAPIModels">
        <d4p1:JobCustomPostingFieldModel>
          <d4p1:FieldLabel>sample string 1</d4p1:FieldLabel>
          <d4p1:FieldValue>sample string 2</d4p1:FieldValue>
        </d4p1:JobCustomPostingFieldModel>
        <d4p1:JobCustomPostingFieldModel>
          <d4p1:FieldLabel>sample string 1</d4p1:FieldLabel>
          <d4p1:FieldValue>sample string 2</d4p1:FieldValue>
        </d4p1:JobCustomPostingFieldModel>
      </d2p1:CustomFields>
      <d2p1:DisabilityStatus>sample string 39</d2p1:DisabilityStatus>
      <d2p1:EEOCategory>sample string 35</d2p1:EEOCategory>
      <d2p1:EmailAddress>sample string 15</d2p1:EmailAddress>
      <d2p1:EthnicOrigin>sample string 37</d2p1:EthnicOrigin>
      <d2p1:FacebookLink>sample string 26</d2p1:FacebookLink>
      <d2p1:FinalDisp>sample string 33</d2p1:FinalDisp>
      <d2p1:FirstName>sample string 16</d2p1:FirstName>
      <d2p1:Gender>sample string 36</d2p1:Gender>
      <d2p1:HiredDate>2021-10-26T15:11:53.2795258-05:00</d2p1:HiredDate>
      <d2p1:JobCandidateId>13</d2p1:JobCandidateId>
      <d2p1:JobCity>sample string 7</d2p1:JobCity>
      <d2p1:JobCreateDate>2021-10-26T15:11:53.2795258-05:00</d2p1:JobCreateDate>
      <d2p1:JobId>4</d2p1:JobId>
      <d2p1:JobSource>sample string 14</d2p1:JobSource>
      <d2p1:JobState>sample string 8</d2p1:JobState>
      <d2p1:JobStatus>sample string 41</d2p1:JobStatus>
      <d2p1:JobTitle>sample string 5</d2p1:JobTitle>
      <d2p1:Labels>sample string 30</d2p1:Labels>
      <d2p1:LastName>sample string 17</d2p1:LastName>
      <d2p1:LastUpdateDate>2021-10-26T15:11:53.2805262-05:00</d2p1:LastUpdateDate>
      <d2p1:LinkedInLink>sample string 27</d2p1:LinkedInLink>
      <d2p1:MainPhone>sample string 23</d2p1:MainPhone>
      <d2p1:OnboardLocation>sample string 6</d2p1:OnboardLocation>
      <d2p1:PostalCode>sample string 22</d2p1:PostalCode>
      <d2p1:ReqNumber>sample string 3</d2p1:ReqNumber>
      <d2p1:ScreeningQuestions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.ATSAPIModels">
        <d4p1:JobScreeningQuestionModel>
          <d4p1:Answer>sample string 2</d4p1:Answer>
          <d4p1:Question>sample string 1</d4p1:Question>
        </d4p1:JobScreeningQuestionModel>
        <d4p1:JobScreeningQuestionModel>
          <d4p1:Answer>sample string 2</d4p1:Answer>
          <d4p1:Question>sample string 1</d4p1:Question>
        </d4p1:JobScreeningQuestionModel>
      </d2p1:ScreeningQuestions>
      <d2p1:SkypeLink>sample string 29</d2p1:SkypeLink>
      <d2p1:StartDate>2021-10-26T15:11:53.2795258-05:00</d2p1:StartDate>
      <d2p1:State>sample string 21</d2p1:State>
      <d2p1:TwitterLink>sample string 28</d2p1:TwitterLink>
      <d2p1:VeteranStatus>sample string 38</d2p1:VeteranStatus>
    </d2p1:ATSJobCandidateV3Model>
  </Candidates>
  <TotalCandidateCount>1</TotalCandidateCount>
</JobCandidatesListResultsModelOfATSJobCandidateV3Model2xqYqMbL>