Skip to main content
GET
/
api
/
Candidates
/
Query
Candidates Query.
curl --request GET \
  --url https://api.example.com/api/Candidates/Query
[
  {
    "id": 123,
    "fullName": "<string>",
    "candidateDisplayName": "<string>",
    "preferredName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email1": "<string>",
    "email2": "<string>",
    "payrollEmail": "<string>",
    "payrollCountry": "<string>",
    "payrollState": "<string>",
    "mobile": "<string>",
    "home": "<string>",
    "work": "<string>",
    "mobile_Standardised": "<string>",
    "home_Standardised": "<string>",
    "work_Standardised": "<string>",
    "jobTitle": "<string>",
    "employer": "<string>",
    "genderID": 123,
    "hasResumeViewerDoc": true,
    "resumeViewerDate": "2023-11-07T05:31:56Z",
    "isOwnerOfHasResumeViewerDoc": true,
    "resumeUpdateDate": "2023-11-07T05:31:56Z",
    "lastUpdateDate": "2023-11-07T05:31:56Z",
    "address1": "<string>",
    "address2": "<string>",
    "suburb": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "countryName": "<string>",
    "countryCode": "<string>",
    "linkedInUrl": "<string>",
    "facebookUrl": "<string>",
    "photoName": "<string>",
    "photoUrl": "<string>",
    "dateOfBirth": "2023-11-07T05:31:56Z",
    "preferredRate": 123,
    "preferredRateUnitsId": 123,
    "preferredRateUnits": "<string>",
    "preferredSalary": 123,
    "preferredSalaryUnitsId": 123,
    "preferredSalaryUnits": "<string>",
    "jobSeekingStatusID": 123,
    "jobSeekingStatusName": "<string>",
    "preferredJobTypeID": 123,
    "preferredJobTypeName": "<string>",
    "summary": "<string>",
    "profileStatusID": 123,
    "candidateClientID": 123,
    "candidateClientName": "<string>",
    "candidatePlacementTypeID": 123,
    "candidatePlacementClientID": 123,
    "candidatePlacementClientName": "<string>",
    "hasResume": true,
    "isRedFlagged": true,
    "redFlaggedDate": "2023-11-07T05:31:56Z",
    "redFlaggedByUserName": "<string>",
    "redFlaggedComments": "<string>",
    "tags": true,
    "divisions": "<string>",
    "availabilityDate": "2023-11-07T05:31:56Z",
    "optOut": true,
    "weeksNotice": 123,
    "nationality": "<string>",
    "nationalityID": 123,
    "website": "<string>",
    "statisticsCounts": [
      {
        "type": "<string>",
        "value": 123
      }
    ],
    "statisticsDates": [
      {
        "type": "<string>",
        "value": "2023-11-07T05:31:56Z"
      }
    ],
    "deleted": true,
    "customField1": "<string>",
    "customField2": "<string>",
    "customField3": "<string>",
    "customField4": "<string>",
    "customField5": "<string>",
    "customField6": "<string>",
    "customField7": "<string>",
    "customField8": "<string>",
    "customField9": "<string>",
    "customField10": "<string>",
    "customField11": "<string>",
    "customField12": "<string>",
    "customField13": "<string>",
    "customField14": "<string>",
    "customField15": "<string>",
    "customField16": "<string>",
    "customField17": "<string>",
    "customField18": "<string>",
    "customField19": "<string>",
    "customField20": "<string>",
    "customField21": "<string>",
    "customField22": "<string>",
    "customField23": "<string>",
    "customField24": "<string>",
    "customField25": "<string>",
    "customField26": "<string>",
    "customField27": "<string>",
    "customField28": "<string>",
    "customField29": "<string>",
    "customField30": "<string>",
    "customField31": "2023-11-07T05:31:56Z",
    "customField32": "2023-11-07T05:31:56Z",
    "customField33": "2023-11-07T05:31:56Z",
    "customField34": "2023-11-07T05:31:56Z",
    "customField35": "2023-11-07T05:31:56Z",
    "customField36": "2023-11-07T05:31:56Z",
    "customField37": "2023-11-07T05:31:56Z",
    "customField38": "2023-11-07T05:31:56Z",
    "customField39": "2023-11-07T05:31:56Z",
    "customField40": "2023-11-07T05:31:56Z",
    "customField41": "2023-11-07T05:31:56Z",
    "customField42": "2023-11-07T05:31:56Z",
    "customField43": "2023-11-07T05:31:56Z",
    "customField44": "2023-11-07T05:31:56Z",
    "customField45": "2023-11-07T05:31:56Z",
    "customField46": 123,
    "customField47": 123,
    "customField48": 123,
    "customField49": 123,
    "customField50": 123,
    "customField51": 123,
    "customField52": 123,
    "customField53": 123,
    "customField54": 123,
    "customField55": 123,
    "customField56": 123,
    "customField57": 123,
    "customField58": 123,
    "customField59": 123,
    "customField60": 123,
    "linkedInProfilePictureUrl": "<string>",
    "originalSource": "<string>",
    "lastApplicationDate": "2023-11-07T05:31:56Z",
    "employmentHistories": [
      {
        "jobTitle": "<string>",
        "employer": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Query Parameters

updatedDate
string<date-time>

Search for candidates updated after a specific date and time.

offset
integer<int32>
default:0

The index of the first entry to return from the resource collection.

limit
integer<int32>
default:100

The Maximum number of records to return.

Response

200 - application/json

OK

id
integer<int32>
fullName
string | null
candidateDisplayName
string | null
preferredName
string | null
firstName
string | null
lastName
string | null
email1
string | null
email2
string | null
payrollEmail
string | null
payrollCountry
string | null
payrollState
string | null
mobile
string | null
home
string | null
work
string | null
mobile_Standardised
string | null
home_Standardised
string | null
work_Standardised
string | null
jobTitle
string | null
employer
string | null
genderID
integer<int32>
hasResumeViewerDoc
boolean
resumeViewerDate
string<date-time> | null
isOwnerOfHasResumeViewerDoc
boolean
resumeUpdateDate
string<date-time> | null
lastUpdateDate
string<date-time> | null
address1
string | null
address2
string | null
suburb
string | null
state
string | null
postcode
string | null
countryName
string | null
countryCode
string | null
linkedInUrl
string | null
facebookUrl
string | null
photoName
string | null
photoUrl
string | null
dateOfBirth
string<date-time>
preferredRate
number<float>
preferredRateUnitsId
integer<int32>
preferredRateUnits
string | null
preferredSalary
number<float>
preferredSalaryUnitsId
integer<int32>
preferredSalaryUnits
string | null
jobSeekingStatusID
integer<int32>
jobSeekingStatusName
string | null
preferredJobTypeID
integer<int32>
preferredJobTypeName
string | null
summary
string | null
profileStatusID
integer<int32>
candidateClientID
integer<int32>
candidateClientName
string | null
candidatePlacementTypeID
integer<int32>
candidatePlacementClientID
integer<int32>
candidatePlacementClientName
string | null
hasResume
boolean
isRedFlagged
boolean
redFlaggedDate
string<date-time> | null
redFlaggedByUserName
string | null
redFlaggedComments
string | null
tags
boolean
divisions
string | null
availabilityDate
string<date-time>
optOut
boolean
weeksNotice
integer<int32>
nationality
string | null
nationalityID
integer<int32>
website
string | null
statisticsCounts
object[] | null
statisticsDates
object[] | null
deleted
boolean
customField1
string | null
customField2
string | null
customField3
string | null
customField4
string | null
customField5
string | null
customField6
string | null
customField7
string | null
customField8
string | null
customField9
string | null
customField10
string | null
customField11
string | null
customField12
string | null
customField13
string | null
customField14
string | null
customField15
string | null
customField16
string | null
customField17
string | null
customField18
string | null
customField19
string | null
customField20
string | null
customField21
string | null
customField22
string | null
customField23
string | null
customField24
string | null
customField25
string | null
customField26
string | null
customField27
string | null
customField28
string | null
customField29
string | null
customField30
string | null
customField31
string<date-time>
customField32
string<date-time>
customField33
string<date-time>
customField34
string<date-time>
customField35
string<date-time>
customField36
string<date-time>
customField37
string<date-time>
customField38
string<date-time>
customField39
string<date-time>
customField40
string<date-time>
customField41
string<date-time>
customField42
string<date-time>
customField43
string<date-time>
customField44
string<date-time>
customField45
string<date-time>
customField46
number<double> | null
customField47
number<double> | null
customField48
number<double> | null
customField49
number<double> | null
customField50
number<double> | null
customField51
number<double> | null
customField52
number<double> | null
customField53
number<double> | null
customField54
number<double> | null
customField55
number<double> | null
customField56
number<double> | null
customField57
number<double> | null
customField58
number<double> | null
customField59
number<double> | null
customField60
number<double> | null
linkedInProfilePictureUrl
string | null
originalSource
string | null
lastApplicationDate
string<date-time> | null
employmentHistories
object[] | null