GET v1/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

Name	Description	Type	Additional 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.

Body Parameters

None.

Response Information

Resource Description

JobCandidatesListResultsModelOfATSJobCandidateModel

Name	Description	Type	Additional information
Candidates		Collection of ATSJobCandidateModel	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": "2024-04-19T08:05:07.3839031-05:00",
      "hiredDate": "2024-04-19T08:05:07.3839031-05:00",
      "candidateId": 11,
      "jobCandidateId": 12,
      "jobSource": "sample string 13",
      "emailAddress": "sample string 14",
      "firstName": "sample string 15",
      "lastName": "sample string 16",
      "addressLine1": "sample string 17",
      "addressLine2": "sample string 18",
      "city": "sample string 19",
      "state": "sample string 20",
      "postalCode": "sample string 21",
      "mainPhone": "sample string 22",
      "altPhone1": "sample string 23",
      "altPhone2": "sample string 24",
      "facebookLink": "sample string 25",
      "linkedInLink": "sample string 26",
      "googlePlusLink": "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": "2024-04-19T08:05:07.3839031-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"
        }
      ]
    },
    {
      "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": "2024-04-19T08:05:07.3839031-05:00",
      "hiredDate": "2024-04-19T08:05:07.3839031-05:00",
      "candidateId": 11,
      "jobCandidateId": 12,
      "jobSource": "sample string 13",
      "emailAddress": "sample string 14",
      "firstName": "sample string 15",
      "lastName": "sample string 16",
      "addressLine1": "sample string 17",
      "addressLine2": "sample string 18",
      "city": "sample string 19",
      "state": "sample string 20",
      "postalCode": "sample string 21",
      "mainPhone": "sample string 22",
      "altPhone1": "sample string 23",
      "altPhone2": "sample string 24",
      "facebookLink": "sample string 25",
      "linkedInLink": "sample string 26",
      "googlePlusLink": "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": "2024-04-19T08:05:07.3839031-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"
        }
      ]
    }
  ],
  "totalCandidateCount": 1,
  "status": "sample string 2",
  "messages": []
}

application/xml, text/xml

Sample:

<JobCandidatesListResultsModelOfATSJobCandidateModelkvfu5mmC 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>
    <ATSJobCandidateModel>
      <AccountId>2</AccountId>
      <AccountName>sample string 1</AccountName>
      <AddressLine1>sample string 17</AddressLine1>
      <AddressLine2>sample string 18</AddressLine2>
      <AltPhone1>sample string 23</AltPhone1>
      <AltPhone2>sample string 24</AltPhone2>
      <ApplyDate>2024-04-19T08:05:07.3839031-05:00</ApplyDate>
      <CandStage>sample string 32</CandStage>
      <CandidateId>11</CandidateId>
      <City>sample string 19</City>
      <CustomAppName>sample string 31</CustomAppName>
      <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>
      </CustomFields>
      <DisabilityStatus>sample string 39</DisabilityStatus>
      <EEOCategory>sample string 35</EEOCategory>
      <EmailAddress>sample string 14</EmailAddress>
      <EthnicOrigin>sample string 37</EthnicOrigin>
      <FacebookLink>sample string 25</FacebookLink>
      <FinalDisp>sample string 33</FinalDisp>
      <FirstName>sample string 15</FirstName>
      <Gender>sample string 36</Gender>
      <GooglePlusLink>sample string 27</GooglePlusLink>
      <HiredDate>2024-04-19T08:05:07.3839031-05:00</HiredDate>
      <JobCandidateId>12</JobCandidateId>
      <JobCity>sample string 7</JobCity>
      <JobCreateDate>2024-04-19T08:05:07.3839031-05:00</JobCreateDate>
      <JobId>4</JobId>
      <JobSource>sample string 13</JobSource>
      <JobState>sample string 8</JobState>
      <JobTitle>sample string 5</JobTitle>
      <Labels>sample string 30</Labels>
      <LastName>sample string 16</LastName>
      <LinkedInLink>sample string 26</LinkedInLink>
      <MainPhone>sample string 22</MainPhone>
      <OnboardLocation>sample string 6</OnboardLocation>
      <PostalCode>sample string 21</PostalCode>
      <ReqNumber>sample string 3</ReqNumber>
      <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>
      </ScreeningQuestions>
      <SkypeLink>sample string 29</SkypeLink>
      <State>sample string 20</State>
      <TwitterLink>sample string 28</TwitterLink>
      <VeteranStatus>sample string 38</VeteranStatus>
    </ATSJobCandidateModel>
    <ATSJobCandidateModel>
      <AccountId>2</AccountId>
      <AccountName>sample string 1</AccountName>
      <AddressLine1>sample string 17</AddressLine1>
      <AddressLine2>sample string 18</AddressLine2>
      <AltPhone1>sample string 23</AltPhone1>
      <AltPhone2>sample string 24</AltPhone2>
      <ApplyDate>2024-04-19T08:05:07.3839031-05:00</ApplyDate>
      <CandStage>sample string 32</CandStage>
      <CandidateId>11</CandidateId>
      <City>sample string 19</City>
      <CustomAppName>sample string 31</CustomAppName>
      <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>
      </CustomFields>
      <DisabilityStatus>sample string 39</DisabilityStatus>
      <EEOCategory>sample string 35</EEOCategory>
      <EmailAddress>sample string 14</EmailAddress>
      <EthnicOrigin>sample string 37</EthnicOrigin>
      <FacebookLink>sample string 25</FacebookLink>
      <FinalDisp>sample string 33</FinalDisp>
      <FirstName>sample string 15</FirstName>
      <Gender>sample string 36</Gender>
      <GooglePlusLink>sample string 27</GooglePlusLink>
      <HiredDate>2024-04-19T08:05:07.3839031-05:00</HiredDate>
      <JobCandidateId>12</JobCandidateId>
      <JobCity>sample string 7</JobCity>
      <JobCreateDate>2024-04-19T08:05:07.3839031-05:00</JobCreateDate>
      <JobId>4</JobId>
      <JobSource>sample string 13</JobSource>
      <JobState>sample string 8</JobState>
      <JobTitle>sample string 5</JobTitle>
      <Labels>sample string 30</Labels>
      <LastName>sample string 16</LastName>
      <LinkedInLink>sample string 26</LinkedInLink>
      <MainPhone>sample string 22</MainPhone>
      <OnboardLocation>sample string 6</OnboardLocation>
      <PostalCode>sample string 21</PostalCode>
      <ReqNumber>sample string 3</ReqNumber>
      <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>
      </ScreeningQuestions>
      <SkypeLink>sample string 29</SkypeLink>
      <State>sample string 20</State>
      <TwitterLink>sample string 28</TwitterLink>
      <VeteranStatus>sample string 38</VeteranStatus>
    </ATSJobCandidateModel>
  </Candidates>
  <TotalCandidateCount>1</TotalCandidateCount>
</JobCandidatesListResultsModelOfATSJobCandidateModelkvfu5mmC>