Appearance
Get a placement
GET
/api/nova/placements/{placementId}
Fetches a single placement by the placementId path variable, subject to the visibility of the API user identified by the apiKey query parameter. Returns the placement record on success. Responds with 404 if the placement does not exist or is not visible to the user, 401 if the apiKey is invalid, and 500 on unexpected failures.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
placementId*
placementId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "candidateId": "string", "candidateName": "string", "candidateRate": 0, "clientRate": 0, "companyId": "string", "companyName": "string", "createdOn": "string", "currency": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "endDate": "string", "fee": 0, "id": "string", "jobId": "string", "jobName": "string", "margin": 0, "ownerId": "string", "ownerName": "string", "placementDate": "string", "reference": "string", "salary": 0, "startDate": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "timeToFillDays": 0, "type": "string", "updatedOn": "string" }, "error": "string", "message": "string", "requestId": "string", "success": true
{
}