Skip to content

List placements​

GET
/api/nova/placements/list

Returns the placements visible to the API user identified by the apiKey query parameter. This endpoint is an alias that delegates to the placement search endpoint, so it accepts the same optional query string plus page and size parameters (default 20, capped at 100), sorted by creation date descending. Returns a paged list of placement records with the total count; an invalid apiKey returns 401 and unexpected failures return 500.

Authorizations​

privateApiKey
Type
API Key (query: apiKey)

Parameters​

Query Parameters

apiKey*

apiKey

Type
string
Required
page

page

Type
integer
Format
"int32"
Default
0
query

query

Type
string
size

size

Type
integer
Format
"int32"
Default
20

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",
  
"page": 0,
  
"requestId": "string",
  
"size": 0,
  
"success": true,
  
"total": 0
}

Playground​

Authorization
Variables
Key
Value

Samples​

Recruitly — Recruitment CRM for Agencies