Skip to main content
POST
/
api
/
Automation
/
Search
/
Placements
/
Filters
Placements search by automation filters.
curl --request POST \
  --url https://api.example.com/api/Automation/Search/Placements/Filters \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": "<string>",
  "nextRunOnly": true,
  "maxRecords": 123,
  "automationId": 123,
  "orderBy": {
    "isAscending": true,
    "columnName": "<string>"
  }
}
'
[
  {
    "id": 123,
    "approved": true,
    "exportedToBackOffice": true,
    "contractValue": 123,
    "netRevenue": 123,
    "altID": "<string>",
    "jobID": 123,
    "candidateID": 123,
    "candidateName": "<string>",
    "placementStatusID": 4,
    "placementStatusName": "<string>",
    "clientID": 123,
    "clientName": "<string>",
    "contactID": 123,
    "contactName": "<string>",
    "hiringManagerName": "<string>",
    "signatoryName": "<string>",
    "billingContactName": "<string>",
    "billingContact2Name": "<string>",
    "billingContact3Name": "<string>",
    "placementTypeID": 1,
    "jobTitle": "<string>",
    "jobRef": "<string>",
    "siteID": 123,
    "siteName": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "suburb": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "countryCode": "<string>",
    "countryName": "<string>",
    "payDivision": 123,
    "division": 123,
    "divisionName": "<string>",
    "updatedByID": 123,
    "createdByRecruiterID": 123,
    "createdByName": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "updatedDate": "2023-11-07T05:31:56Z",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "originalStartDate": "2023-11-07T05:31:56Z",
    "placementDate": "2023-11-07T05:31:56Z",
    "agencyID": 123,
    "salary": 123,
    "duration": 123,
    "cancellationReason": 123,
    "parentPlacementID": 123,
    "hiringManagerContactID": 123,
    "signatoryContactID": 123,
    "billingContactContactID": 123,
    "billingContact2ContactID": 123,
    "billingContact3ContactID": 123,
    "durationPeriod": 123,
    "permFeePercentage": 123,
    "permFeeAmount": 123,
    "salaryUnits": 123,
    "probationLength": 123,
    "warrantyLength": 123,
    "feeType": 123,
    "approvalDate": "2023-11-07T05:31:56Z",
    "approvedByRecruiterID": 123,
    "payFrequencyID": 123,
    "clientReference": "<string>",
    "approvedByConsultantName": "<string>",
    "noticePeriod": 123,
    "noticePeriodUnits": 123,
    "clientNoticePeriod": 123,
    "clientNoticePeriodUnits": 123,
    "paymentTypeID": 123,
    "paymentCompanyID": 123,
    "paymentContactID": 123,
    "payComments": "<string>",
    "paymentCompanyName": "<string>",
    "paymentContactName": "<string>",
    "paymentContactEmail": "<string>",
    "paymentContactMobile_Standardised": "<string>",
    "source": "<string>",
    "summary": "<string>",
    "currencyID": 123,
    "currencyName": "<string>",
    "candidateFirstName": "<string>",
    "candidateLastName": "<string>",
    "candidateEmail": "<string>",
    "candidateOptOut": true,
    "candidateTel1_Standardised": "<string>",
    "candidateLastContact": "2023-11-07T05:31:56Z",
    "contactFirstName": "<string>",
    "contactSurName": "<string>",
    "contactEmail": "<string>",
    "contactMobile_Standardised": "<string>",
    "contactLastContact": "2023-11-07T05:31:56Z",
    "hiringManagerFirstName": "<string>",
    "hiringManagerSurName": "<string>",
    "hiringManagerEmail": "<string>",
    "hiringManagerMobile_Standardised": "<string>",
    "billingContactFirstName": "<string>",
    "billingContactSurName": "<string>",
    "billingContactEmail": "<string>",
    "billingContactMobile_Standardised": "<string>",
    "deleted": true,
    "billingGroupID": 123,
    "billingGroupName": "<string>",
    "workHistoryId": 123,
    "isPayrollTaxExempt": 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",
    "extendedDate": "2023-11-07T05:31:56Z",
    "timesheetApprover1": 123,
    "timesheetApprover1Name": "<string>",
    "timesheetApprover1Email": "<string>",
    "timesheetApprover1Mobile": "<string>",
    "timesheetApprover2": 123,
    "timesheetApprover2Name": "<string>",
    "timesheetApprover2Email": "<string>",
    "timesheetApprover2Mobile": "<string>",
    "tags": true,
    "approvedCount": 123,
    "firstApprovedDate": "2023-11-07T05:31:56Z",
    "isAmendment": true,
    "isExtension": true,
    "isValidated": true,
    "isChangeRequestPending": true,
    "isTimesheetDataAvailable": true,
    "isConvertedToPerm": true,
    "numberOfRateCards": 123,
    "numberOfPendingChangeRequests": 123,
    "payRateUnitsName": "<string>",
    "chargeRateUnitsName": "<string>",
    "onCostsUnitsName": "<string>",
    "salaryUnitsName": "<string>",
    "placementTypeName": "<string>",
    "paymentTypeName": "<string>",
    "payFrequencyName": "<string>",
    "invoiceFee": "<string>",
    "invoiceFeePercentage": "<string>",
    "invoiceFeeDollarAmount": "<string>",
    "shortAddress": "<string>",
    "fullAddress": "<string>",
    "complianceChecklistID": 123,
    "complianceChecklistName": "<string>",
    "cancellationComments": "<string>",
    "terminationComments": "<string>",
    "initialContractValue": 123,
    "rateCardID": 123,
    "payRate": 123,
    "chargeRate": 123,
    "onCosts": 123,
    "payRateUnits": 123,
    "chargeRateUnits": 123,
    "onCostsUnits": 123,
    "consultantID1": 123,
    "consultantID2": 123,
    "consultantID3": 123,
    "consultantID4": 123,
    "consultantID5": 123,
    "consultantName1": "<string>",
    "consultantName2": "<string>",
    "consultantName3": "<string>",
    "consultantName4": "<string>",
    "consultantName5": "<string>",
    "consultantPercentage1": 123,
    "consultantPercentage2": 123,
    "consultantPercentage3": 123,
    "consultantPercentage4": 123,
    "consultantPercentage5": 123,
    "hoursPerDay": 123,
    "daysPerWeek": 123,
    "averageDailyMargin": 123,
    "averageHourlyMargin": 123,
    "dailyMargin": 123,
    "hourlyMargin": 123,
    "statisticsCounts": [
      {
        "type": "<string>",
        "value": 123
      }
    ],
    "statisticsDates": [
      {
        "type": "<string>",
        "value": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Body

application/json
filters
string | null
nextRunOnly
boolean
maxRecords
integer<int32>
automationId
integer<int32>
orderBy
object

Response

200 - application/json

OK

id
integer<int32>
approved
boolean
exportedToBackOffice
boolean
contractValue
number<double>
netRevenue
number<double>
altID
string | null
jobID
integer<int32>
candidateID
integer<int32>
candidateName
string | null
placementStatusID
enum<integer>
Available options:
4,
5,
6,
8,
10,
11,
12,
13,
14
placementStatusName
string | null
clientID
integer<int32>
clientName
string | null
contactID
integer<int32>
contactName
string | null
hiringManagerName
string | null
signatoryName
string | null
billingContactName
string | null
billingContact2Name
string | null
billingContact3Name
string | null
placementTypeID
enum<integer>
Available options:
1,
2,
3,
4,
5,
7
jobTitle
string | null
jobRef
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
payDivision
integer<int32>
division
integer<int32>
divisionName
string | null
updatedByID
integer<int32>
createdByRecruiterID
integer<int32>
createdByName
string | null
createdDate
string<date-time>
updatedDate
string<date-time>
startDate
string<date-time>
endDate
string<date-time>
originalStartDate
string<date-time>
placementDate
string<date-time>
agencyID
integer<int32>
salary
number<double>
duration
integer<int32>
cancellationReason
integer<int32>
parentPlacementID
integer<int32>
hiringManagerContactID
integer<int32>
signatoryContactID
integer<int32>
billingContactContactID
integer<int32>
billingContact2ContactID
integer<int32>
billingContact3ContactID
integer<int32>
durationPeriod
integer<int32>
permFeePercentage
number<double>
permFeeAmount
number<double>
salaryUnits
integer<int32>
probationLength
integer<int32>
warrantyLength
integer<int32>
feeType
integer<int32>
approvalDate
string<date-time>
approvedByRecruiterID
integer<int32>
payFrequencyID
integer<int32>
clientReference
string | null
approvedByConsultantName
string | null
noticePeriod
integer<int32>
noticePeriodUnits
integer<int32>
clientNoticePeriod
integer<int32>
clientNoticePeriodUnits
integer<int32>
paymentTypeID
integer<int32>
paymentCompanyID
integer<int32>
paymentContactID
integer<int32>
payComments
string | null
paymentCompanyName
string | null
paymentContactName
string | null
paymentContactEmail
string | null
paymentContactMobile_Standardised
string | null
source
string | null
summary
string | null
currencyID
integer<int32>
currencyName
string | null
candidateFirstName
string | null
candidateLastName
string | null
candidateEmail
string | null
candidateOptOut
boolean
candidateTel1_Standardised
string | null
candidateLastContact
string<date-time> | null
contactFirstName
string | null
contactSurName
string | null
contactEmail
string | null
contactMobile_Standardised
string | null
contactLastContact
string<date-time> | null
hiringManagerFirstName
string | null
hiringManagerSurName
string | null
hiringManagerEmail
string | null
hiringManagerMobile_Standardised
string | null
billingContactFirstName
string | null
billingContactSurName
string | null
billingContactEmail
string | null
billingContactMobile_Standardised
string | null
deleted
boolean
billingGroupID
integer<int32> | null
billingGroupName
string | null
workHistoryId
integer<int32>
isPayrollTaxExempt
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>
extendedDate
string<date-time>
timesheetApprover1
integer<int32>
timesheetApprover1Name
string | null
timesheetApprover1Email
string | null
timesheetApprover1Mobile
string | null
timesheetApprover2
integer<int32>
timesheetApprover2Name
string | null
timesheetApprover2Email
string | null
timesheetApprover2Mobile
string | null
tags
boolean
approvedCount
integer<int32>
firstApprovedDate
string<date-time>
isAmendment
boolean
isExtension
boolean
isValidated
boolean
isChangeRequestPending
boolean
isTimesheetDataAvailable
boolean
isConvertedToPerm
boolean
numberOfRateCards
integer<int32>
numberOfPendingChangeRequests
integer<int32>
payRateUnitsName
string | null
chargeRateUnitsName
string | null
onCostsUnitsName
string | null
salaryUnitsName
string | null
placementTypeName
string | null
paymentTypeName
string | null
payFrequencyName
string | null
invoiceFee
string | null
invoiceFeePercentage
string | null
invoiceFeeDollarAmount
string | null
shortAddress
string | null
fullAddress
string | null
complianceChecklistID
integer<int32>
complianceChecklistName
string | null
cancellationComments
string | null
terminationComments
string | null
initialContractValue
number<double>
rateCardID
integer<int32>
payRate
number<double>
chargeRate
number<double>
onCosts
number<double>
payRateUnits
integer<int32>
chargeRateUnits
integer<int32>
onCostsUnits
integer<int32>
consultantID1
integer<int32>
consultantID2
integer<int32>
consultantID3
integer<int32>
consultantID4
integer<int32>
consultantID5
integer<int32>
consultantName1
string | null
consultantName2
string | null
consultantName3
string | null
consultantName4
string | null
consultantName5
string | null
consultantPercentage1
number<double>
consultantPercentage2
number<double>
consultantPercentage3
number<double>
consultantPercentage4
number<double>
consultantPercentage5
number<double>
hoursPerDay
number<double>
daysPerWeek
number<double>
averageDailyMargin
number<double>
averageHourlyMargin
number<double>
dailyMargin
number<double>
hourlyMargin
number<double>
statisticsCounts
object[] | null
statisticsDates
object[] | null