Skip to content

Get a specific placement from the database​

GET
/placements/{PlacementId}

Authorizations​

Bearer

Please create a SessionId using the access-token endpoint and use it in an authorization header.

TypeHTTP (bearer)
Example'Authorization: BEARER <YOUR_TOKEN_HERE>'

Responses​

application/json
JSON
{
"AggregateCount": 0,
"MetaData": null,
"PlacementId": 0,
"ReplicationId": "string",
"StartDate": "string",
"EndDate": "string",
"PlacementDate": "string",
"PlacementType": null,
"CompanyName": "string",
"CompanyId": 0,
"JobTitle": "string",
"PositionId": "string",
"JobId": 0,
"CandidateName": "string",
"CandidateId": 0,
"PlacedBy": "string",
"BillRate": {
"CurrencyCode": null,
"Value": 0
},
"PayRate": {
"CurrencyCode": null,
"Value": 0
},
"Feedback": "string",
"Guarantee": "string",
"Notes": "string",
"PlacementStatus": "string",
"CurrentStatus": "string",
"Interviewer": [
{
"CandidateId": 0,
"Name": "string"
}
],
"VisibleOnWeb": true,
"CurrentInterview": "string",
"DefaultCurrency": "string",
"StartingSalary": {
"CurrencyCode": null,
"Value": 0
},
"PlacementFee": {
"CurrencyCode": null,
"Value": 0
},
"FeePercentage": 0,
"LastModified": "string",
"OvertimeBillRate": {
"CurrencyCode": null,
"Value": 0
},
"OvertimePayRate": {
"CurrencyCode": null,
"Value": 0
},
"OnCallBillRate": {
"CurrencyCode": null,
"Value": 0
},
"OnCallPayRate": {
"CurrencyCode": null,
"Value": 0
},
"HolidayBillRate": {
"CurrencyCode": null,
"Value": 0
},
"HolidayPayRate": {
"CurrencyCode": null,
"Value": 0
},
"DoubleTimeBillRate": {
"CurrencyCode": null,
"Value": 0
},
"DoubleTimePayRate": {
"CurrencyCode": null,
"Value": 0
},
"PerDiemDaily": {
"CurrencyCode": null,
"Value": 0
},
"PerDiemHourly": {
"CurrencyCode": null,
"Value": 0
},
"Rank": 0,
"BurdenRate": 0,
"BurdenState": "string",
"PayPeriod": "string",
"PayPeriodStartDay": "string",
"ShowTimeClock": null,
"Deleted": true,
"OverTimeDoubleTimeZone": "string",
"CustomFields": [
],
"SplitDeskDistribution": [
{
"AggregateCount": 0,
"MetaData": null,
"SplitdeskId": 0,
"InterviewId": 0,
"UserName": "string",
"SplitdeskTypeId": 0,
"SplitdeskTypeName": "string",
"SplitAllocation": 0
}
],
"ApproverList": [
{
"EmailName": "string",
"EmailAddress": "string"
}
],
"Commissions": [
{
"AggregateCount": 0,
"MetaData": null,
"CommissionId": 0,
"PlacementId": 0,
"Date": "string",
"UserName": "string",
"Description": "string",
"Amount": {
"CurrencyCode": null,
"Value": 0
}
}
],
"ScheduleEvents": {
"SaveAsDefault": true,
"AlarmItems": true,
"Candidate": {
"ScheduleDates": {
"ThirtyBefore": true,
"FourteenBefore": true,
"SevenBefore": true,
"ThreeBefore": true,
"OneBefore": true,
"Start": true,
"SevenAfter": true,
"FourteenAfter": true,
"ThirtyAfter": true,
"SixtyAfter": true,
"NinetyAfter": true,
"OneHundredTwentyAfter": true,
"OneHundredEightyAfter": true,
"ThreeHundredSixtyFiveAfter": true
},
"ScheduleTimes": {
"BeforeTime": "string",
"StartTime": "string",
"AfterTime": "string"
}
},
"PositionContact": {
"ScheduleDates": {
"ThirtyBefore": true,
"FourteenBefore": true,
"SevenBefore": true,
"ThreeBefore": true,
"OneBefore": true,
"Start": true,
"SevenAfter": true,
"FourteenAfter": true,
"ThirtyAfter": true,
"SixtyAfter": true,
"NinetyAfter": true,
"OneHundredTwentyAfter": true,
"OneHundredEightyAfter": true,
"ThreeHundredSixtyFiveAfter": true
},
"ScheduleTimes": {
"BeforeTime": "string",
"StartTime": "string",
"AfterTime": "string"
}
}
},
"PONumber": "string",
"EstimatedWeeksWorked": 0,
"EstimatedTotalRevenue": {
"CurrencyCode": null,
"Value": 0
},
"EstimatedTotalCost": {
"CurrencyCode": null,
"Value": 0
},
"EstimatedTotalProfit": {
"CurrencyCode": null,
"Value": 0
},
"ExpenseCategories": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​