Skip to main content
POST
/
api
/
Contacts
/
Search
Contacts Search.
curl --request POST \
  --url https://api.example.com/api/Contacts/Search \
  --header 'Content-Type: application/json' \
  --data '
{
  "ssid": 123,
  "owner": [
    "<string>"
  ],
  "status": [
    123
  ],
  "rating": "<string>",
  "division": [
    123
  ],
  "location": "<string>",
  "longitude": "<string>",
  "latitude": "<string>",
  "radius": "<string>",
  "jobTitle": "<string>",
  "includeSites": true,
  "taggedTimeRange": "<string>",
  "includeTags": [
    {
      "tag": "<string>",
      "typeId": 123,
      "source": "<string>"
    }
  ],
  "excludeTags": [
    {
      "tag": "<string>",
      "typeId": 123,
      "source": "<string>"
    }
  ],
  "includeTagsMatchAll": true,
  "createdBy": [
    123
  ],
  "createdDateFrom": "2023-11-07T05:31:56Z",
  "createdDateTo": "2023-11-07T05:31:56Z",
  "updatedDateFrom": "2023-11-07T05:31:56Z",
  "updatedDateTo": "2023-11-07T05:31:56Z",
  "jobTypeIds": [
    123
  ],
  "jobCreatedFrom": "2023-11-07T05:31:56Z",
  "jobCreatedTo": "2023-11-07T05:31:56Z",
  "placementTypeIds": [
    123
  ],
  "placementCreatedFrom": "2023-11-07T05:31:56Z",
  "placementCreatedTo": "2023-11-07T05:31:56Z",
  "noteTypeIds": [
    123
  ],
  "noteCreatedFrom": "2023-11-07T05:31:56Z",
  "noteCreatedTo": "2023-11-07T05:31:56Z",
  "noteAssignedUsers": [
    123
  ],
  "meetingTypeIds": [
    123
  ],
  "meetingCreatedFrom": "2023-11-07T05:31:56Z",
  "meetingCreatedTo": "2023-11-07T05:31:56Z",
  "meetingAssignedUsers": [
    123
  ],
  "interviewTypeIds": [
    123
  ],
  "interviewCreatedFrom": "2023-11-07T05:31:56Z",
  "interviewCreatedTo": "2023-11-07T05:31:56Z",
  "interviewAssignedUsers": [
    123
  ],
  "submissionCreatedFrom": "2023-11-07T05:31:56Z",
  "submissionCreatedTo": "2023-11-07T05:31:56Z",
  "submissionAssignedUsers": [
    123
  ],
  "noteContents": "<string>"
}
'
[
  {
    "firstName": "<string>",
    "surname": "<string>",
    "fullName": "<string>",
    "siteID": 123,
    "siteName": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "suburb": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "countryCode": "<string>",
    "countryName": "<string>",
    "phone": "<string>",
    "phone_Standardised": "<string>",
    "mobile": "<string>",
    "mobile_Standardised": "<string>",
    "clientID": 123,
    "clientName": "<string>",
    "email": "<string>",
    "email2": "<string>",
    "jobTitle": "<string>",
    "linkedInURL": "<string>",
    "description": "<string>",
    "photoName": "<string>",
    "photoUrl": "<string>",
    "id": 123,
    "openJobs": "<string>",
    "placements": "<string>",
    "contractors": "<string>",
    "createdByID": 123,
    "createdByName": "<string>",
    "updatedByID": 123,
    "updatedByName": "<string>",
    "linkedCandidateID": 123,
    "linkedCandidateName": "<string>",
    "divisions": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "updatedDate": "2023-11-07T05:31:56Z",
    "lastActivityDate": "2023-11-07T05:31:56Z",
    "nextActivityDate": "2023-11-07T05:31:56Z",
    "lastContactDate": "2023-11-07T05:31:56Z",
    "nextContactDate": "2023-11-07T05:31:56Z",
    "lastMeetingDate": "2023-11-07T05:31:56Z",
    "nextMeetingDate": "2023-11-07T05:31:56Z",
    "reportsToID": 123,
    "reportsToName": "<string>",
    "statusID": 123,
    "statusName": "<string>",
    "optOut": true,
    "deleted": true,
    "customField1": "<string>",
    "customField2": "<string>",
    "customField3": "<string>",
    "customField4": "<string>",
    "customField5": "<string>",
    "customField6": "<string>",
    "customField7": "<string>",
    "customField8": "<string>",
    "customField9": "<string>",
    "customField10": "<string>",
    "customField11": 123,
    "customField12": 123,
    "customField13": 123,
    "customField14": 123,
    "customField15": 123,
    "customField16": "2023-11-07T05:31:56Z",
    "customField17": "2023-11-07T05:31:56Z",
    "customField18": "2023-11-07T05:31:56Z",
    "customField19": "2023-11-07T05:31:56Z",
    "customField20": "2023-11-07T05:31:56Z",
    "customField21": "<string>",
    "customField22": "<string>",
    "customField23": "<string>",
    "customField24": "<string>",
    "customField25": "<string>",
    "customField26": "<string>",
    "customField27": "<string>",
    "customField28": "<string>",
    "customField29": "<string>",
    "customField30": "<string>",
    "customField31": "<string>",
    "customField32": "<string>",
    "customField33": "<string>",
    "customField34": "<string>",
    "customField35": "<string>",
    "customField36": "<string>",
    "customField37": "<string>",
    "customField38": "<string>",
    "customField39": "<string>",
    "customField40": "<string>",
    "customField41": 123,
    "customField42": 123,
    "customField43": 123,
    "customField44": 123,
    "customField45": 123,
    "customField46": 123,
    "customField47": 123,
    "customField48": 123,
    "customField49": 123,
    "customField50": 123,
    "customField51": "2023-11-07T05:31:56Z",
    "customField52": "2023-11-07T05:31:56Z",
    "customField53": "2023-11-07T05:31:56Z",
    "customField54": "2023-11-07T05:31:56Z",
    "customField55": "2023-11-07T05:31:56Z",
    "customField56": "2023-11-07T05:31:56Z",
    "customField57": "2023-11-07T05:31:56Z",
    "customField58": "2023-11-07T05:31:56Z",
    "customField59": "2023-11-07T05:31:56Z",
    "customField60": "2023-11-07T05:31:56Z",
    "tags": true,
    "location": "<string>",
    "statisticsCounts": [
      {
        "type": "<string>",
        "value": 123
      }
    ],
    "statisticsDates": [
      {
        "type": "<string>",
        "value": "2023-11-07T05:31:56Z"
      }
    ],
    "linkedInProfilePictureUrl": "<string>"
  }
]

Body

application/json
ssid
integer<int32>
owner
string[] | null
status
integer<int32>[] | null
rating
string | null
division
integer<int32>[] | null
location
string | null
longitude
string | null
latitude
string | null
radius
string | null
jobTitle
string | null
includeSites
boolean | null
taggedTimeRange
string | null
includeTags
object[] | null
excludeTags
object[] | null
includeTagsMatchAll
boolean | null
createdBy
integer<int32>[] | null
createdDateFrom
string<date-time> | null
createdDateTo
string<date-time> | null
updatedDateFrom
string<date-time> | null
updatedDateTo
string<date-time> | null
jobTypeIds
integer<int32>[] | null
jobCreatedFrom
string<date-time> | null
jobCreatedTo
string<date-time> | null
placementTypeIds
integer<int32>[] | null
placementCreatedFrom
string<date-time> | null
placementCreatedTo
string<date-time> | null
noteTypeIds
integer<int32>[] | null
noteCreatedFrom
string<date-time> | null
noteCreatedTo
string<date-time> | null
noteAssignedUsers
integer<int32>[] | null
meetingTypeIds
integer<int32>[] | null
meetingCreatedFrom
string<date-time> | null
meetingCreatedTo
string<date-time> | null
meetingAssignedUsers
integer<int32>[] | null
interviewTypeIds
integer<int32>[] | null
interviewCreatedFrom
string<date-time> | null
interviewCreatedTo
string<date-time> | null
interviewAssignedUsers
integer<int32>[] | null
submissionCreatedFrom
string<date-time> | null
submissionCreatedTo
string<date-time> | null
submissionAssignedUsers
integer<int32>[] | null
noteContents
string | null

Response

200 - application/json

OK

firstName
string | null
surname
string | null
fullName
string | null
siteID
integer<int32>
siteName
string | null
address1
string | null
address2
string | null
address3
string | null
suburb
string | null
state
string | null
postcode
string | null
countryCode
string | null
countryName
string | null
phone
string | null
phone_Standardised
string | null
mobile
string | null
mobile_Standardised
string | null
clientID
integer<int32>
clientName
string | null
email
string | null
email2
string | null
jobTitle
string | null
linkedInURL
string | null
description
string | null
photoName
string | null
photoUrl
string | null
id
integer<int32>
openJobs
string | null
placements
string | null
contractors
string | null
createdByID
integer<int32>
createdByName
string | null
updatedByID
integer<int32>
updatedByName
string | null
linkedCandidateID
integer<int32>
linkedCandidateName
string | null
divisions
string | null
createdDate
string<date-time>
updatedDate
string<date-time>
lastActivityDate
string<date-time>
nextActivityDate
string<date-time>
lastContactDate
string<date-time>
nextContactDate
string<date-time>
lastMeetingDate
string<date-time>
nextMeetingDate
string<date-time>
reportsToID
integer<int32>
reportsToName
string | null
statusID
integer<int32>
statusName
string | null
optOut
boolean
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
number<double> | null
customField12
number<double> | null
customField13
number<double> | null
customField14
number<double> | null
customField15
number<double> | null
customField16
string<date-time>
customField17
string<date-time>
customField18
string<date-time>
customField19
string<date-time>
customField20
string<date-time>
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 | null
customField32
string | null
customField33
string | null
customField34
string | null
customField35
string | null
customField36
string | null
customField37
string | null
customField38
string | null
customField39
string | null
customField40
string | null
customField41
number<double> | null
customField42
number<double> | null
customField43
number<double> | null
customField44
number<double> | null
customField45
number<double> | null
customField46
number<double> | null
customField47
number<double> | null
customField48
number<double> | null
customField49
number<double> | null
customField50
number<double> | null
customField51
string<date-time>
customField52
string<date-time>
customField53
string<date-time>
customField54
string<date-time>
customField55
string<date-time>
customField56
string<date-time>
customField57
string<date-time>
customField58
string<date-time>
customField59
string<date-time>
customField60
string<date-time>
tags
boolean
location
string | null
statisticsCounts
object[] | null
statisticsDates
object[] | null
linkedInProfilePictureUrl
string | null