Appearance
API Reference
Interactive documentation for the Recruitly Nova API. Try endpoints directly from the browser.
The Recruitly Nova API is a simple, lightweight REST API that responds to https requests with JSON. Because it is a REST API, it is completely stateless. Requests are expected to be made in the form of a simple HTTP GET.
Terms of Service
https://recruitly.io/terms-of-serviceServers
https://api.recruitly.io
Candidates
Operations
POST/api/nova/candidatesPOST/api/nova/candidates/parseGET/api/nova/candidates/searchGET/api/nova/candidates/{candidateId}PUT/api/nova/candidates/{candidateId}DELETE/api/nova/candidates/{candidateId}PUT/api/nova/candidates/{candidateId}/internalnotesPUT/api/nova/candidates/{candidateId}/overviewPUT/api/nova/candidates/{candidateId}/sourcePUT/api/nova/candidates/{candidateId}/statusPUT/api/nova/candidates/{candidateId}/tags
Create a candidate
POST
/api/nova/candidates
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "string", "currentEmployer": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "doNotContact": true, "educationHistory": [ { "educationLevelId": "string", "endYear": 0, "grade": "string", "major": "string", "organisation": "string", "startYear": 0 } ], "email": "string", "employmentHistory": [ { "companyName": "string", "employmentTypeId": "string", "endDate": "string", "jobTitle": "string", "startDate": "string", "workSummary": "string" } ], "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "internalNotes": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "overview": "string", "ownerId": "string", "rating": 0, "rightToWork": true, "skills": [ "string" ], "sourceId": "string", "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "twitter": "string", "workPermit": true, "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Parse a CV into a candidate
POST
/api/nova/candidates/parse
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Request Body
multipart/form-data
Format
"binary"Responses
OK
application/json
JSON "data": { "candidateId": "string", "cvFileId": "string", "cvFileName": "string", "duplicate": true, "name": "string", "reference": "string" }, "error": "string", "message": "string", "success": true
{
}
Search candidates
GET
/api/nova/candidates/search
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "alternateEmail": "string", "createdOn": "string", "currentEmployer": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "doNotContact": true, "educationHistory": [ { "endYear": 0, "grade": "string", "id": "string", "level": "string", "major": "string", "organisation": "string", "startYear": 0 } ], "email": "string", "employmentHistory": [ { "companyName": "string", "employmentType": "string", "endDate": "string", "id": "string", "jobTitle": "string", "startDate": "string", "workSummary": "string" } ], "facebook": "string", "firstName": "string", "hasCv": true, "homePhone": "string", "id": "string", "inPipeline": true, "internalNotes": "string", "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "overview": "string", "ownerId": "string", "ownerName": "string", "placed": true, "rating": 0, "reference": "string", "rightToWork": true, "skills": [ "string" ], "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "workPermit": true, "workPhone": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Get candidate by ID
GET
/api/nova/candidates/{candidateId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "alternateEmail": "string", "createdOn": "string", "currentEmployer": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "doNotContact": true, "educationHistory": [ { "endYear": 0, "grade": "string", "id": "string", "level": "string", "major": "string", "organisation": "string", "startYear": 0 } ], "email": "string", "employmentHistory": [ { "companyName": "string", "employmentType": "string", "endDate": "string", "id": "string", "jobTitle": "string", "startDate": "string", "workSummary": "string" } ], "facebook": "string", "firstName": "string", "hasCv": true, "homePhone": "string", "id": "string", "inPipeline": true, "internalNotes": "string", "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "overview": "string", "ownerId": "string", "ownerName": "string", "placed": true, "rating": 0, "reference": "string", "rightToWork": true, "skills": [ "string" ], "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "workPermit": true, "workPhone": "string" }, "error": "string", "message": "string", "success": true
{
}
Update a candidate
PUT
/api/nova/candidates/{candidateId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "string", "currentEmployer": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "doNotContact": true, "educationHistory": [ { "educationLevelId": "string", "endYear": 0, "grade": "string", "major": "string", "organisation": "string", "startYear": 0 } ], "email": "string", "employmentHistory": [ { "companyName": "string", "employmentTypeId": "string", "endDate": "string", "jobTitle": "string", "startDate": "string", "workSummary": "string" } ], "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "internalNotes": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "overview": "string", "ownerId": "string", "rating": 0, "rightToWork": true, "skills": [ "string" ], "sourceId": "string", "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "twitter": "string", "workPermit": true, "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Delete a candidate
DELETE
/api/nova/candidates/{candidateId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update candidate internal notes
PUT
/api/nova/candidates/{candidateId}/internalnotes
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "text": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update candidate overview
PUT
/api/nova/candidates/{candidateId}/overview
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "text": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update candidate source
PUT
/api/nova/candidates/{candidateId}/source
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "referrerId": "string", "sourceId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update candidate status
PUT
/api/nova/candidates/{candidateId}/status
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "comments": "string", "reasonId": "string", "statusId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Replace candidate tags
PUT
/api/nova/candidates/{candidateId}/tags
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
candidateId*
candidateId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "tags": [ { "group": "string", "value": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Companies
Operations
POST/api/nova/companiesGET/api/nova/companies/listGET/api/nova/companies/searchGET/api/nova/companies/{companyId}PUT/api/nova/companies/{companyId}PUT/api/nova/companies/{companyId}/internalnotesPUT/api/nova/companies/{companyId}/overviewPUT/api/nova/companies/{companyId}/sourcePUT/api/nova/companies/{companyId}/statusPUT/api/nova/companies/{companyId}/tags
Create a company
POST
/api/nova/companies
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "annualRevenue": 0, "client": true, "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "domain": "string", "email": "string", "employeeCount": 0, "facebook": "string", "faxNo": "string", "foundedYear": 0, "id": "string", "linkedIn": "string", "name": "string", "ownerId": "string", "parentCompanyId": "string", "phone": "string", "rating": 0, "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "twitter": "string", "website": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
List all companies
GET
/api/nova/companies/list
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "activeJobCount": 0, "annualRevenue": 0, "client": true, "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "domain": "string", "email": "string", "employeeCount": 0, "facebook": "string", "faxNo": "string", "foundedYear": 0, "id": "string", "industryId": "string", "industryName": "string", "lastActivityDate": "string", "linkedIn": "string", "location": "string", "name": "string", "ownerId": "string", "ownerName": "string", "parentCompanyId": "string", "parentCompanyName": "string", "phone": "string", "rating": 0, "reference": "string", "sectorId": "string", "sectorName": "string", "size": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "totalPlacementCount": 0, "twitter": "string", "updatedOn": "string", "website": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Search companies
GET
/api/nova/companies/search
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "activeJobCount": 0, "annualRevenue": 0, "client": true, "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "domain": "string", "email": "string", "employeeCount": 0, "facebook": "string", "faxNo": "string", "foundedYear": 0, "id": "string", "industryId": "string", "industryName": "string", "lastActivityDate": "string", "linkedIn": "string", "location": "string", "name": "string", "ownerId": "string", "ownerName": "string", "parentCompanyId": "string", "parentCompanyName": "string", "phone": "string", "rating": 0, "reference": "string", "sectorId": "string", "sectorName": "string", "size": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "totalPlacementCount": 0, "twitter": "string", "updatedOn": "string", "website": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Get company by ID
GET
/api/nova/companies/{companyId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
companyId*
companyId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "activeJobCount": 0, "annualRevenue": 0, "client": true, "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "domain": "string", "email": "string", "employeeCount": 0, "facebook": "string", "faxNo": "string", "foundedYear": 0, "id": "string", "industryId": "string", "industryName": "string", "lastActivityDate": "string", "linkedIn": "string", "location": "string", "name": "string", "ownerId": "string", "ownerName": "string", "parentCompanyId": "string", "parentCompanyName": "string", "phone": "string", "rating": 0, "reference": "string", "sectorId": "string", "sectorName": "string", "size": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "totalPlacementCount": 0, "twitter": "string", "updatedOn": "string", "website": "string" }, "error": "string", "message": "string", "success": true
{
}
Update a company
PUT
/api/nova/companies/{companyId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
companyId*
companyId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "annualRevenue": 0, "client": true, "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "domain": "string", "email": "string", "employeeCount": 0, "facebook": "string", "faxNo": "string", "foundedYear": 0, "id": "string", "linkedIn": "string", "name": "string", "ownerId": "string", "parentCompanyId": "string", "phone": "string", "rating": 0, "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "twitter": "string", "website": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update company internal notes
PUT
/api/nova/companies/{companyId}/internalnotes
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
companyId*
companyId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "text": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update company overview (client description)
PUT
/api/nova/companies/{companyId}/overview
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
companyId*
companyId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "text": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update company source
PUT
/api/nova/companies/{companyId}/source
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
companyId*
companyId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "referrerId": "string", "sourceId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update company status
PUT
/api/nova/companies/{companyId}/status
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
companyId*
companyId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "comments": "string", "reasonId": "string", "statusId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Replace company tags
PUT
/api/nova/companies/{companyId}/tags
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
companyId*
companyId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "tags": [ { "group": "string", "value": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Contacts
Operations
POST/api/nova/contactsGET/api/nova/contacts/listGET/api/nova/contacts/searchGET/api/nova/contacts/{contactId}PUT/api/nova/contacts/{contactId}PUT/api/nova/contacts/{contactId}/internalnotesPUT/api/nova/contacts/{contactId}/overviewPUT/api/nova/contacts/{contactId}/sourcePUT/api/nova/contacts/{contactId}/statusPUT/api/nova/contacts/{contactId}/tags
Create a contact
POST
/api/nova/contacts
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "string", "companyId": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "description": "string", "email": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "internalNotes": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "ownerId": "string", "secondaryCompanyId": "string", "skills": [ "string" ], "skype": "string", "sourceId": "string", "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "twitter": "string", "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
List all contacts
GET
/api/nova/contacts/list
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "alternateEmail": "string", "companyId": "string", "companyName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "description": "string", "doNotContact": true, "email": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industries": [ "string" ], "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "reference": "string", "secondaryCompanyId": "string", "secondaryCompanyName": "string", "sectors": [ "string" ], "skills": [ "string" ], "skype": "string", "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "workPhone": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Search contacts
GET
/api/nova/contacts/search
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "alternateEmail": "string", "companyId": "string", "companyName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "description": "string", "doNotContact": true, "email": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industries": [ "string" ], "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "reference": "string", "secondaryCompanyId": "string", "secondaryCompanyName": "string", "sectors": [ "string" ], "skills": [ "string" ], "skype": "string", "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "workPhone": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Get contact by ID
GET
/api/nova/contacts/{contactId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
contactId*
contactId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "alternateEmail": "string", "companyId": "string", "companyName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "description": "string", "doNotContact": true, "email": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industries": [ "string" ], "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "reference": "string", "secondaryCompanyId": "string", "secondaryCompanyName": "string", "sectors": [ "string" ], "skills": [ "string" ], "skype": "string", "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "workPhone": "string" }, "error": "string", "message": "string", "success": true
{
}
Update a contact
PUT
/api/nova/contacts/{contactId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
contactId*
contactId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "string", "companyId": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "description": "string", "email": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "internalNotes": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "ownerId": "string", "secondaryCompanyId": "string", "skills": [ "string" ], "skype": "string", "sourceId": "string", "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "twitter": "string", "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update contact internal notes
PUT
/api/nova/contacts/{contactId}/internalnotes
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
contactId*
contactId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "text": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update contact overview
PUT
/api/nova/contacts/{contactId}/overview
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
contactId*
contactId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "text": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update contact source
PUT
/api/nova/contacts/{contactId}/source
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
contactId*
contactId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "referrerId": "string", "sourceId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update contact status
PUT
/api/nova/contacts/{contactId}/status
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
contactId*
contactId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "comments": "string", "reasonId": "string", "statusId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Replace contact tags
PUT
/api/nova/contacts/{contactId}/tags
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
contactId*
contactId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "tags": [ { "group": "string", "value": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Jobs
Operations
POST/api/nova/jobsGET/api/nova/jobs/listGET/api/nova/jobs/searchGET/api/nova/jobs/{jobId}PUT/api/nova/jobs/{jobId}DELETE/api/nova/jobs/{jobId}GET/api/nova/jobs/{jobId}/pipelinePOST/api/nova/jobs/{jobId}/pipelinePUT/api/nova/jobs/{jobId}/pipeline/{pipelineId}/statusPUT/api/nova/jobs/{jobId}/sourcePUT/api/nova/jobs/{jobId}/statusPUT/api/nova/jobs/{jobId}/tags
Create a job
POST
/api/nova/jobs
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "closingDate": "string", "companyId": "string", "contactId": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "employmentTypeId": "string", "experienceLevelId": "string", "flexiHours": true, "hot": true, "id": "string", "internalDescription": "string", "maxPay": 0, "minPay": 0, "openPositions": 0, "ownerId": "string", "payCurrency": "string", "payTenure": "string", "rating": 0, "relocation": true, "remoteWorking": true, "shortDescription": "string", "skills": [ "string" ], "sourceId": "string", "startDate": "string", "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "title": "string", "visaSponsored": true
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
List all jobs
GET
/api/nova/jobs/list
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "closingDate": "string", "companyId": "string", "companyName": "string", "contactId": "string", "contactName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOpened": "string", "employmentTypeId": "string", "employmentTypeName": "string", "experienceLevelId": "string", "experienceLevelName": "string", "flexiHours": true, "hot": true, "id": "string", "internalDescription": "string", "lastActivityDate": "string", "location": "string", "maxPay": 0, "minPay": 0, "openPositions": 0, "ownerId": "string", "ownerName": "string", "payCurrency": "string", "payTenure": "string", "rating": 0, "reference": "string", "relocation": true, "remoteWorking": true, "shortDescription": "string", "skills": [ "string" ], "sourceId": "string", "sourceName": "string", "startDate": "string", "statusId": "string", "statusName": "string", "statusReason": "string", "tags": [ { "group": "string", "value": "string" } ], "title": "string", "updatedOn": "string", "visaSponsored": true } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Search jobs
GET
/api/nova/jobs/search
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "closingDate": "string", "companyId": "string", "companyName": "string", "contactId": "string", "contactName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOpened": "string", "employmentTypeId": "string", "employmentTypeName": "string", "experienceLevelId": "string", "experienceLevelName": "string", "flexiHours": true, "hot": true, "id": "string", "internalDescription": "string", "lastActivityDate": "string", "location": "string", "maxPay": 0, "minPay": 0, "openPositions": 0, "ownerId": "string", "ownerName": "string", "payCurrency": "string", "payTenure": "string", "rating": 0, "reference": "string", "relocation": true, "remoteWorking": true, "shortDescription": "string", "skills": [ "string" ], "sourceId": "string", "sourceName": "string", "startDate": "string", "statusId": "string", "statusName": "string", "statusReason": "string", "tags": [ { "group": "string", "value": "string" } ], "title": "string", "updatedOn": "string", "visaSponsored": true } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Get job by ID
GET
/api/nova/jobs/{jobId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "closingDate": "string", "companyId": "string", "companyName": "string", "contactId": "string", "contactName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOpened": "string", "employmentTypeId": "string", "employmentTypeName": "string", "experienceLevelId": "string", "experienceLevelName": "string", "flexiHours": true, "hot": true, "id": "string", "internalDescription": "string", "lastActivityDate": "string", "location": "string", "maxPay": 0, "minPay": 0, "openPositions": 0, "ownerId": "string", "ownerName": "string", "payCurrency": "string", "payTenure": "string", "rating": 0, "reference": "string", "relocation": true, "remoteWorking": true, "shortDescription": "string", "skills": [ "string" ], "sourceId": "string", "sourceName": "string", "startDate": "string", "statusId": "string", "statusName": "string", "statusReason": "string", "tags": [ { "group": "string", "value": "string" } ], "title": "string", "updatedOn": "string", "visaSponsored": true }, "error": "string", "message": "string", "success": true
{
}
Update a job
PUT
/api/nova/jobs/{jobId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "closingDate": "string", "companyId": "string", "contactId": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "employmentTypeId": "string", "experienceLevelId": "string", "flexiHours": true, "hot": true, "id": "string", "internalDescription": "string", "maxPay": 0, "minPay": 0, "openPositions": 0, "ownerId": "string", "payCurrency": "string", "payTenure": "string", "rating": 0, "relocation": true, "remoteWorking": true, "shortDescription": "string", "skills": [ "string" ], "sourceId": "string", "startDate": "string", "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "title": "string", "visaSponsored": true
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Delete a job
List candidates in a job's pipeline
GET
/api/nova/jobs/{jobId}/pipeline
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "candidateId": "string", "candidateName": "string", "createdOn": "string", "id": "string", "jobId": "string", "rejected": true, "stage": "string", "status": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Attach a candidate to a job's pipeline at a chosen stage
POST
/api/nova/jobs/{jobId}/pipeline
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "candidateId": "string", "stateId": "string", "statusCode": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update a pipeline entry's status / stage
PUT
/api/nova/jobs/{jobId}/pipeline/{pipelineId}/status
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
pipelineId*
pipelineId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "stateId": "string", "statusCode": "string"
{
}
Responses
OK
application/json
JSON "data": { "candidateId": "string", "candidateName": "string", "createdOn": "string", "id": "string", "jobId": "string", "rejected": true, "stage": "string", "status": "string" }, "error": "string", "message": "string", "success": true
{
}
Update job source
PUT
/api/nova/jobs/{jobId}/source
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "referrerId": "string", "sourceId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update job status
PUT
/api/nova/jobs/{jobId}/status
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "comments": "string", "reasonId": "string", "statusId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Replace job tags
PUT
/api/nova/jobs/{jobId}/tags
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "tags": [ { "group": "string", "value": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Get activities for a record
GET
/api/nova/journal/{recordId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
recordId*
recordId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "additionalProperties": { } } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Create a lead
POST
/api/nova/leads
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "string", "companyName": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "doNotContact": true, "email": "string", "employees": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industryId": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "ownerId": "string", "rating": 0, "sectorId": "string", "sourceId": "string", "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "twitter": "string", "website": "string", "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
List all leads
GET
/api/nova/leads/list
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "alternateEmail": "string", "companyName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "doNotContact": true, "email": "string", "employees": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industryId": "string", "industryName": "string", "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "pipelineId": "string", "pipelineName": "string", "rating": 0, "reference": "string", "sectorId": "string", "sectorName": "string", "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "website": "string", "workPhone": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Search leads
GET
/api/nova/leads/search
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "alternateEmail": "string", "companyName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "doNotContact": true, "email": "string", "employees": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industryId": "string", "industryName": "string", "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "pipelineId": "string", "pipelineName": "string", "rating": 0, "reference": "string", "sectorId": "string", "sectorName": "string", "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "website": "string", "workPhone": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Get lead by ID
GET
/api/nova/leads/{leadId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
leadId*
leadId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "alternateEmail": "string", "companyName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "doNotContact": true, "email": "string", "employees": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industryId": "string", "industryName": "string", "jobTitle": "string", "lastActivityDate": "string", "lastName": "string", "linkedIn": "string", "location": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "pipelineId": "string", "pipelineName": "string", "rating": 0, "reference": "string", "sectorId": "string", "sectorName": "string", "sourceId": "string", "sourceName": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "updatedOn": "string", "website": "string", "workPhone": "string" }, "error": "string", "message": "string", "success": true
{
}
Update a lead
PUT
/api/nova/leads/{leadId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
leadId*
leadId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "string", "companyName": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "doNotContact": true, "email": "string", "employees": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "industryId": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "ownerId": "string", "rating": 0, "sectorId": "string", "sourceId": "string", "statusId": "string", "tags": [ { "additionalProperties": "string" } ], "twitter": "string", "website": "string", "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Delete a lead
DELETE
/api/nova/leads/{leadId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
leadId*
leadId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update lead overview (description)
PUT
/api/nova/leads/{leadId}/overview
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
leadId*
leadId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "text": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update lead source
PUT
/api/nova/leads/{leadId}/source
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
leadId*
leadId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "referrerId": "string", "sourceId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update lead status
PUT
/api/nova/leads/{leadId}/status
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
leadId*
leadId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "comments": "string", "reasonId": "string", "statusId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Replace lead tags
PUT
/api/nova/leads/{leadId}/tags
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
leadId*
leadId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "tags": [ { "group": "string", "value": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Get all lookup data
GET
/api/nova/lookup
Returns system-level lookup/enum data (countries, languages, nationalities, record types).
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { }, "error": "string", "message": "string", "success": true
{
}
Get all master data
GET
/api/nova/masterdata
Returns all master/configuration data grouped by type. Lightweight — only id and name per item.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "activityTypes": [ { "id": "string", "name": "string" } ], "candidateStatuses": [ { "id": "string", "name": "string" } ], "companyStatuses": [ { "id": "string", "name": "string" } ], "companyTypes": [ { "id": "string", "name": "string" } ], "contactStatuses": [ { "id": "string", "name": "string" } ], "educationLevels": [ { "id": "string", "name": "string" } ], "employmentTypes": [ { "id": "string", "name": "string" } ], "genders": [ { "id": "string", "name": "string" } ], "industries": [ { "id": "string", "name": "string" } ], "invoiceStatuses": [ { "id": "string", "name": "string" } ], "jobApplicationLabels": [ { "id": "string", "name": "string" } ], "jobPipelineRejectReasons": [ { "id": "string", "name": "string" } ], "jobPipelineStages": [ { "id": "string", "name": "string" } ], "jobStatuses": [ { "id": "string", "name": "string" } ], "leadPipelines": [ { "id": "string", "name": "string" } ], "leadStatuses": [ { "id": "string", "name": "string" } ], "opportunityPipelines": [ { "id": "string", "name": "string" } ], "opportunityStates": [ { "id": "string", "name": "string" } ], "placementStatuses": [ { "id": "string", "name": "string" } ], "recruitingTeamRoles": [ { "id": "string", "name": "string" } ], "sectors": [ { "id": "string", "name": "string" } ], "skills": [ { "id": "string", "name": "string" } ], "sources": [ { "id": "string", "name": "string" } ] }, "error": "string", "message": "string", "success": true
{
}
Opportunities
Operations
POST/api/nova/opportunitiesGET/api/nova/opportunities/listGET/api/nova/opportunities/searchGET/api/nova/opportunities/{opportunityId}PUT/api/nova/opportunities/{opportunityId}DELETE/api/nova/opportunities/{opportunityId}PUT/api/nova/opportunities/{opportunityId}/sourcePUT/api/nova/opportunities/{opportunityId}/statusPUT/api/nova/opportunities/{opportunityId}/tags
Create an opportunity
POST
/api/nova/opportunities
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "actualClosingDate": "string", "bidCurrency": "string", "bidValue": 0, "companyId": "string", "contactId": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "estimatedDurationMonths": 0, "forecastedClosingDate": "string", "id": "string", "name": "string", "ownerId": "string", "probability": 0, "startDate": "string", "stateId": "string", "tags": [ { "additionalProperties": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
List all opportunities
GET
/api/nova/opportunities/list
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "actualClosingDate": "string", "bidCurrency": "string", "bidValue": 0, "companyId": "string", "companyName": "string", "contactId": "string", "contactName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "estimatedDurationMonths": 0, "forecastedClosingDate": "string", "id": "string", "name": "string", "ownerId": "string", "ownerName": "string", "probability": 0, "reference": "string", "startDate": "string", "stateId": "string", "stateName": "string", "stateReason": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "updatedOn": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Search opportunities
GET
/api/nova/opportunities/search
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "actualClosingDate": "string", "bidCurrency": "string", "bidValue": 0, "companyId": "string", "companyName": "string", "contactId": "string", "contactName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "estimatedDurationMonths": 0, "forecastedClosingDate": "string", "id": "string", "name": "string", "ownerId": "string", "ownerName": "string", "probability": 0, "reference": "string", "startDate": "string", "stateId": "string", "stateName": "string", "stateReason": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "updatedOn": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Get opportunity by ID
GET
/api/nova/opportunities/{opportunityId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
opportunityId*
opportunityId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "actualClosingDate": "string", "bidCurrency": "string", "bidValue": 0, "companyId": "string", "companyName": "string", "contactId": "string", "contactName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "estimatedDurationMonths": 0, "forecastedClosingDate": "string", "id": "string", "name": "string", "ownerId": "string", "ownerName": "string", "probability": 0, "reference": "string", "startDate": "string", "stateId": "string", "stateName": "string", "stateReason": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "updatedOn": "string" }, "error": "string", "message": "string", "success": true
{
}
Update an opportunity
PUT
/api/nova/opportunities/{opportunityId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
opportunityId*
opportunityId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "actualClosingDate": "string", "bidCurrency": "string", "bidValue": 0, "companyId": "string", "contactId": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "estimatedDurationMonths": 0, "forecastedClosingDate": "string", "id": "string", "name": "string", "ownerId": "string", "probability": 0, "startDate": "string", "stateId": "string", "tags": [ { "additionalProperties": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Delete an opportunity
DELETE
/api/nova/opportunities/{opportunityId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
opportunityId*
opportunityId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update opportunity source
PUT
/api/nova/opportunities/{opportunityId}/source
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
opportunityId*
opportunityId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "referrerId": "string", "sourceId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Update opportunity state (won/lost/open)
PUT
/api/nova/opportunities/{opportunityId}/status
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
opportunityId*
opportunityId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "comments": "string", "reasonId": "string", "statusId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Replace opportunity tags
PUT
/api/nova/opportunities/{opportunityId}/tags
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
opportunityId*
opportunityId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "tags": [ { "group": "string", "value": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Get pipeline candidates for a job
GET
/api/nova/pipelines/job/{jobId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
50Responses
OK
application/json
JSON "data": [ { "candidateId": "string", "candidateName": "string", "createdOn": "string", "id": "string", "jobId": "string", "rejected": true, "stage": "string", "status": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
List all placements
GET
/api/nova/placements/list
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
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, "size": 0, "success": true, "total": 0
{
}
Search placements
GET
/api/nova/placements/search
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20Responses
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, "size": 0, "success": true, "total": 0
{
}
Get placement by ID
GET
/api/nova/placements/{placementId}
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", "success": true
{
}
Update placement status
PUT
/api/nova/placements/{placementId}/status
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
placementId*
placementId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "comments": "string", "reasonId": "string", "statusId": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Replace placement tags
PUT
/api/nova/placements/{placementId}/tags
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
placementId*
placementId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "tags": [ { "group": "string", "value": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "success": true
{
}
Public Jobs
Operations
GET/api/nova/public/jobsGET/api/nova/public/jobs/client/{companyId}GET/api/nova/public/jobs/countGET/api/nova/public/jobs/industriesGET/api/nova/public/jobs/languagesGET/api/nova/public/jobs/locationsGET/api/nova/public/jobs/sectorsGET/api/nova/public/jobs/skillsGET/api/nova/public/jobs/typesGET/api/nova/public/jobs/{jobId}
List all active jobs
GET
/api/nova/public/jobs
Returns open jobs only. Supports filtering and pagination.
Authorizations
publicApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
country
country
Type
string
industries
industries
Type
string
jobTypes
jobTypes
Type
string
keywords
keywords
Type
string
location
location
Type
string
pageNumber
pageNumber
Type
integer
Format
"int32"Default
0pageSize
pageSize
Type
integer
Format
"int32"Default
20paginated
paginated
Type
boolean
Default
falsesectors
sectors
Type
string
Responses
OK
application/json
JSON "data": [ { "aiInstruction": "string", "applyEmail": "string", "applyUrl": "string", "archived": true, "bannerImage": { "bucket": "string", "category": "string", "categoryId": "string", "categoryName": "string", "contentType": "string", "createdOn": "string", "defaultDisplayFileInPortal": true, "docType": true, "expiresOn": "dd/MM/yyyy", "fileSize": 0, "id": "string", "imageType": true, "key": "string", "modifiedOn": "string", "name": "string", "owner": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "alternateEmail": "string", "cvId": "string", "doNotContact": true, "email": "string", "employerName": "string", "hasCv": true, "headline": "string", "homePhone": "string", "id": "string", "inSpecificJob": true, "initials": "string", "jobPipelines": [ { "jobId": "string", "jobReference": "string", "pipelineStatus": "string", "placed": true, "rejected": true, "subStatus": "string" } ], "label": "string", "labels": [ { "bgColor": "string", "filterId": "string", "id": "string", "message": "string", "name": "string", "ownerId": "string", "parentLabelId": "string", "parentLabelName": "string", "position": 0, "shared": true, "sharedSelectedUsers": true, "sharedWith": [ { "email": "string", "id": "string", "name": "string", "profileImageUrl": "string", "recordId": "string", "reference": "string", "tenantId": "string", "type": "string" } ], "success": true, "textColor": "string", "type": "string" } ], "linkedIn": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "params": { "additionalProperties": "string" }, "profileImageUrl": "string", "rating": 0, "recordType": "string", "reference": "string", "tenantId": "string", "tenantName": "string", "website": "string", "workPhone": "string" }, "reference": "string", "shared": true, "showInClientPortal": true, "signed": { "expiresOn": 0, "signedUrl": "string" }, "url": "string", "visibleToRecord": true }, "benefits": [ "string" ], "clientBrief": "string", "companyName": "string", "cutOffDate": "dd/MM/yyyy", "description": "string", "employmentType": "string", "estClosingDate": "dd/MM/yyyy", "experience": "string", "hot": true, "id": "string", "industries": [ { "category": "string", "color": "string", "createdBy": "string", "id": "string", "masterDataType": "string", "message": "string", "name": "string", "position": 0, "reasons": [ { "defaultReason": true, "id": "string", "name": "string", "orderNumber": 0, "statusId": "string" } ], "success": true, "synonyms": [ "string" ], "tenantId": "string", "type": { "code": "string", "id": "string", "name": "string" }, "userName": "string", "values": [ "string" ] } ], "industry": "string", "internalDescription": "string", "jobDetailImage": { "bucket": "string", "category": "string", "categoryId": "string", "categoryName": "string", "contentType": "string", "createdOn": "string", "defaultDisplayFileInPortal": true, "docType": true, "expiresOn": "dd/MM/yyyy", "fileSize": 0, "id": "string", "imageType": true, "key": "string", "modifiedOn": "string", "name": "string", "owner": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "alternateEmail": "string", "cvId": "string", "doNotContact": true, "email": "string", "employerName": "string", "hasCv": true, "headline": "string", "homePhone": "string", "id": "string", "inSpecificJob": true, "initials": "string", "jobPipelines": [ { "jobId": "string", "jobReference": "string", "pipelineStatus": "string", "placed": true, "rejected": true, "subStatus": "string" } ], "label": "string", "labels": [ { "bgColor": "string", "filterId": "string", "id": "string", "message": "string", "name": "string", "ownerId": "string", "parentLabelId": "string", "parentLabelName": "string", "position": 0, "shared": true, "sharedSelectedUsers": true, "sharedWith": [ { "email": "string", "id": "string", "name": "string", "profileImageUrl": "string", "recordId": "string", "reference": "string", "tenantId": "string", "type": "string" } ], "success": true, "textColor": "string", "type": "string" } ], "linkedIn": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "params": { "additionalProperties": "string" }, "profileImageUrl": "string", "rating": 0, "recordType": "string", "reference": "string", "tenantId": "string", "tenantName": "string", "website": "string", "workPhone": "string" }, "reference": "string", "shared": true, "showInClientPortal": true, "signed": { "expiresOn": 0, "signedUrl": "string" }, "url": "string", "visibleToRecord": true }, "jobType": "string", "languages": [ { "code": "string", "level": { "code": "string", "name": "string", "orderNumber": 0 }, "name": "string" } ], "location": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "openings": 0, "ownerId": "string", "ownerName": "string", "packageOverview": "string", "pay": { "candidateRate": 0, "currency": { "code": "string", "id": "string", "name": "string", "symbol": "string" }, "daysPerWeek": 0, "endDate": "yyyy-MM-dd", "endTime": "string", "hoursPerDay": 0, "jobEndDate": "string", "jobPayLabel": "string", "jobStartDate": "string", "label": "string", "maxPay": 0, "minPay": 0, "onCosts": 0, "payLabel": "string", "payRate": 0, "range": true, "startDate": "yyyy-MM-dd", "startTime": "string", "tenure": { "code": "string", "id": "string", "name": "string" } }, "postedOn": "dd/MM/yyyy", "publishToWebsite": true, "recruiter": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryName": "string", "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string" }, "aiAgent": true, "archived": true, "calendarColor": "string", "createdOn": "string", "disabled": true, "email": "string", "emailConnected": true, "fullName": "string", "headline": "string", "id": "string", "initials": "string", "languages": [ "string" ], "linkedIn": "string", "masterDataPrivileges": [ "string" ], "mobile": "string", "modifiedOn": "string", "modules": [ "string" ], "nickname": "string", "office": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryName": "string", "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string" }, "id": "string", "name": "string", "phone": "string" }, "privileges": { "anonymise": true, "bulkEmail": true, "bulkSms": true, "deleteData": true, "deleteEmails": true, "exportData": true, "invoiceReconciliation": true }, "profilePicUrl": "string", "role": "string", "teamId": "string", "teamName": "string", "timeZone": "string", "twoFactorEnforced": true, "uniqueId": 0, "workPhone": "string" }, "recruitingTeam": { "members": [ { "email": "string", "id": "string", "initials": "string", "name": "string", "owner": true, "profileImageUrl": "string", "role": "string" } ] }, "reference": "string", "remoteWorking": true, "scorecardTemplate": { "createdOn": "string", "generatedFrom": "string", "groups": [ { "attributes": [ { "id": "string", "label": "string" } ], "category": "string", "name": "string" } ], "modifiedByUserEmail": "string", "modifiedOn": "string" }, "sector": "string", "sectors": [ { "category": "string", "color": "string", "createdBy": "string", "id": "string", "masterDataType": "string", "message": "string", "name": "string", "position": 0, "reasons": [ { "defaultReason": true, "id": "string", "name": "string", "orderNumber": 0, "statusId": "string" } ], "success": true, "synonyms": [ "string" ], "tenantId": "string", "type": { "code": "string", "id": "string", "name": "string" }, "userName": "string", "values": [ "string" ] } ], "shortDescription": "string", "skills": [ "string" ], "status": "string", "tags": [ { "key": "string", "value": "string" } ], "tenantId": "string", "title": "string", "uniqueId": 0, "webAdvert": { "coreSkills": "string", "keyLanguages": "string", "mainResponsibilities": "string", "recruitmentProcess": "string", "whatWillYouLearn": "string", "whatsOnOffer": "string" } } ], "message": "string", "metadata": { }, "success": true, "totalCount": 0, "totalValue": 0
{
}
Get jobs by client company
GET
/api/nova/public/jobs/client/{companyId}
Returns open jobs linked to a specific client company.
Authorizations
publicApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
companyId*
companyId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
includeArchived
includeArchived
Type
boolean
Default
falseResponses
OK
application/json
JSON "data": [ { "aiInstruction": "string", "applyEmail": "string", "applyUrl": "string", "archived": true, "bannerImage": { "bucket": "string", "category": "string", "categoryId": "string", "categoryName": "string", "contentType": "string", "createdOn": "string", "defaultDisplayFileInPortal": true, "docType": true, "expiresOn": "dd/MM/yyyy", "fileSize": 0, "id": "string", "imageType": true, "key": "string", "modifiedOn": "string", "name": "string", "owner": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "alternateEmail": "string", "cvId": "string", "doNotContact": true, "email": "string", "employerName": "string", "hasCv": true, "headline": "string", "homePhone": "string", "id": "string", "inSpecificJob": true, "initials": "string", "jobPipelines": [ { "jobId": "string", "jobReference": "string", "pipelineStatus": "string", "placed": true, "rejected": true, "subStatus": "string" } ], "label": "string", "labels": [ { "bgColor": "string", "filterId": "string", "id": "string", "message": "string", "name": "string", "ownerId": "string", "parentLabelId": "string", "parentLabelName": "string", "position": 0, "shared": true, "sharedSelectedUsers": true, "sharedWith": [ { "email": "string", "id": "string", "name": "string", "profileImageUrl": "string", "recordId": "string", "reference": "string", "tenantId": "string", "type": "string" } ], "success": true, "textColor": "string", "type": "string" } ], "linkedIn": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "params": { "additionalProperties": "string" }, "profileImageUrl": "string", "rating": 0, "recordType": "string", "reference": "string", "tenantId": "string", "tenantName": "string", "website": "string", "workPhone": "string" }, "reference": "string", "shared": true, "showInClientPortal": true, "signed": { "expiresOn": 0, "signedUrl": "string" }, "url": "string", "visibleToRecord": true }, "benefits": [ "string" ], "clientBrief": "string", "companyName": "string", "cutOffDate": "dd/MM/yyyy", "description": "string", "employmentType": "string", "estClosingDate": "dd/MM/yyyy", "experience": "string", "hot": true, "id": "string", "industries": [ { "category": "string", "color": "string", "createdBy": "string", "id": "string", "masterDataType": "string", "message": "string", "name": "string", "position": 0, "reasons": [ { "defaultReason": true, "id": "string", "name": "string", "orderNumber": 0, "statusId": "string" } ], "success": true, "synonyms": [ "string" ], "tenantId": "string", "type": { "code": "string", "id": "string", "name": "string" }, "userName": "string", "values": [ "string" ] } ], "industry": "string", "internalDescription": "string", "jobDetailImage": { "bucket": "string", "category": "string", "categoryId": "string", "categoryName": "string", "contentType": "string", "createdOn": "string", "defaultDisplayFileInPortal": true, "docType": true, "expiresOn": "dd/MM/yyyy", "fileSize": 0, "id": "string", "imageType": true, "key": "string", "modifiedOn": "string", "name": "string", "owner": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "alternateEmail": "string", "cvId": "string", "doNotContact": true, "email": "string", "employerName": "string", "hasCv": true, "headline": "string", "homePhone": "string", "id": "string", "inSpecificJob": true, "initials": "string", "jobPipelines": [ { "jobId": "string", "jobReference": "string", "pipelineStatus": "string", "placed": true, "rejected": true, "subStatus": "string" } ], "label": "string", "labels": [ { "bgColor": "string", "filterId": "string", "id": "string", "message": "string", "name": "string", "ownerId": "string", "parentLabelId": "string", "parentLabelName": "string", "position": 0, "shared": true, "sharedSelectedUsers": true, "sharedWith": [ { "email": "string", "id": "string", "name": "string", "profileImageUrl": "string", "recordId": "string", "reference": "string", "tenantId": "string", "type": "string" } ], "success": true, "textColor": "string", "type": "string" } ], "linkedIn": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "params": { "additionalProperties": "string" }, "profileImageUrl": "string", "rating": 0, "recordType": "string", "reference": "string", "tenantId": "string", "tenantName": "string", "website": "string", "workPhone": "string" }, "reference": "string", "shared": true, "showInClientPortal": true, "signed": { "expiresOn": 0, "signedUrl": "string" }, "url": "string", "visibleToRecord": true }, "jobType": "string", "languages": [ { "code": "string", "level": { "code": "string", "name": "string", "orderNumber": 0 }, "name": "string" } ], "location": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "openings": 0, "ownerId": "string", "ownerName": "string", "packageOverview": "string", "pay": { "candidateRate": 0, "currency": { "code": "string", "id": "string", "name": "string", "symbol": "string" }, "daysPerWeek": 0, "endDate": "yyyy-MM-dd", "endTime": "string", "hoursPerDay": 0, "jobEndDate": "string", "jobPayLabel": "string", "jobStartDate": "string", "label": "string", "maxPay": 0, "minPay": 0, "onCosts": 0, "payLabel": "string", "payRate": 0, "range": true, "startDate": "yyyy-MM-dd", "startTime": "string", "tenure": { "code": "string", "id": "string", "name": "string" } }, "postedOn": "dd/MM/yyyy", "publishToWebsite": true, "recruiter": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryName": "string", "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string" }, "aiAgent": true, "archived": true, "calendarColor": "string", "createdOn": "string", "disabled": true, "email": "string", "emailConnected": true, "fullName": "string", "headline": "string", "id": "string", "initials": "string", "languages": [ "string" ], "linkedIn": "string", "masterDataPrivileges": [ "string" ], "mobile": "string", "modifiedOn": "string", "modules": [ "string" ], "nickname": "string", "office": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryName": "string", "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string" }, "id": "string", "name": "string", "phone": "string" }, "privileges": { "anonymise": true, "bulkEmail": true, "bulkSms": true, "deleteData": true, "deleteEmails": true, "exportData": true, "invoiceReconciliation": true }, "profilePicUrl": "string", "role": "string", "teamId": "string", "teamName": "string", "timeZone": "string", "twoFactorEnforced": true, "uniqueId": 0, "workPhone": "string" }, "recruitingTeam": { "members": [ { "email": "string", "id": "string", "initials": "string", "name": "string", "owner": true, "profileImageUrl": "string", "role": "string" } ] }, "reference": "string", "remoteWorking": true, "scorecardTemplate": { "createdOn": "string", "generatedFrom": "string", "groups": [ { "attributes": [ { "id": "string", "label": "string" } ], "category": "string", "name": "string" } ], "modifiedByUserEmail": "string", "modifiedOn": "string" }, "sector": "string", "sectors": [ { "category": "string", "color": "string", "createdBy": "string", "id": "string", "masterDataType": "string", "message": "string", "name": "string", "position": 0, "reasons": [ { "defaultReason": true, "id": "string", "name": "string", "orderNumber": 0, "statusId": "string" } ], "success": true, "synonyms": [ "string" ], "tenantId": "string", "type": { "code": "string", "id": "string", "name": "string" }, "userName": "string", "values": [ "string" ] } ], "shortDescription": "string", "skills": [ "string" ], "status": "string", "tags": [ { "key": "string", "value": "string" } ], "tenantId": "string", "title": "string", "uniqueId": 0, "webAdvert": { "coreSkills": "string", "keyLanguages": "string", "mainResponsibilities": "string", "recruitmentProcess": "string", "whatWillYouLearn": "string", "whatsOnOffer": "string" } } ], "message": "string", "metadata": { }, "success": true, "totalCount": 0, "totalValue": 0
{
}
Count all active jobs
List job industries with job counts
List job languages with job counts
List job locations with job counts
List job sectors with job counts
List job skills with job counts
List job types with job counts
Get a job by ID or reference
GET
/api/nova/public/jobs/{jobId}
Pass either the job's ObjectId or its reference (e.g. JB-123).
Authorizations
publicApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
jobId*
jobId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "aiInstruction": "string", "applyEmail": "string", "applyUrl": "string", "archived": true, "bannerImage": { "bucket": "string", "category": "string", "categoryId": "string", "categoryName": "string", "contentType": "string", "createdOn": "string", "defaultDisplayFileInPortal": true, "docType": true, "expiresOn": "dd/MM/yyyy", "fileSize": 0, "id": "string", "imageType": true, "key": "string", "modifiedOn": "string", "name": "string", "owner": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "alternateEmail": "string", "cvId": "string", "doNotContact": true, "email": "string", "employerName": "string", "hasCv": true, "headline": "string", "homePhone": "string", "id": "string", "inSpecificJob": true, "initials": "string", "jobPipelines": [ { "jobId": "string", "jobReference": "string", "pipelineStatus": "string", "placed": true, "rejected": true, "subStatus": "string" } ], "label": "string", "labels": [ { "bgColor": "string", "filterId": "string", "id": "string", "message": "string", "name": "string", "ownerId": "string", "parentLabelId": "string", "parentLabelName": "string", "position": 0, "shared": true, "sharedSelectedUsers": true, "sharedWith": [ { "email": "string", "id": "string", "name": "string", "profileImageUrl": "string", "recordId": "string", "reference": "string", "tenantId": "string", "type": "string" } ], "success": true, "textColor": "string", "type": "string" } ], "linkedIn": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "params": { "additionalProperties": "string" }, "profileImageUrl": "string", "rating": 0, "recordType": "string", "reference": "string", "tenantId": "string", "tenantName": "string", "website": "string", "workPhone": "string" }, "reference": "string", "shared": true, "showInClientPortal": true, "signed": { "expiresOn": 0, "signedUrl": "string" }, "url": "string", "visibleToRecord": true }, "benefits": [ "string" ], "clientBrief": "string", "companyName": "string", "cutOffDate": "dd/MM/yyyy", "description": "string", "employmentType": "string", "estClosingDate": "dd/MM/yyyy", "experience": "string", "hot": true, "id": "string", "industries": [ { "category": "string", "color": "string", "createdBy": "string", "id": "string", "masterDataType": "string", "message": "string", "name": "string", "position": 0, "reasons": [ { "defaultReason": true, "id": "string", "name": "string", "orderNumber": 0, "statusId": "string" } ], "success": true, "synonyms": [ "string" ], "tenantId": "string", "type": { "code": "string", "id": "string", "name": "string" }, "userName": "string", "values": [ "string" ] } ], "industry": "string", "internalDescription": "string", "jobDetailImage": { "bucket": "string", "category": "string", "categoryId": "string", "categoryName": "string", "contentType": "string", "createdOn": "string", "defaultDisplayFileInPortal": true, "docType": true, "expiresOn": "dd/MM/yyyy", "fileSize": 0, "id": "string", "imageType": true, "key": "string", "modifiedOn": "string", "name": "string", "owner": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "alternateEmail": "string", "cvId": "string", "doNotContact": true, "email": "string", "employerName": "string", "hasCv": true, "headline": "string", "homePhone": "string", "id": "string", "inSpecificJob": true, "initials": "string", "jobPipelines": [ { "jobId": "string", "jobReference": "string", "pipelineStatus": "string", "placed": true, "rejected": true, "subStatus": "string" } ], "label": "string", "labels": [ { "bgColor": "string", "filterId": "string", "id": "string", "message": "string", "name": "string", "ownerId": "string", "parentLabelId": "string", "parentLabelName": "string", "position": 0, "shared": true, "sharedSelectedUsers": true, "sharedWith": [ { "email": "string", "id": "string", "name": "string", "profileImageUrl": "string", "recordId": "string", "reference": "string", "tenantId": "string", "type": "string" } ], "success": true, "textColor": "string", "type": "string" } ], "linkedIn": "string", "mobile": "string", "ownerId": "string", "ownerName": "string", "params": { "additionalProperties": "string" }, "profileImageUrl": "string", "rating": 0, "recordType": "string", "reference": "string", "tenantId": "string", "tenantName": "string", "website": "string", "workPhone": "string" }, "reference": "string", "shared": true, "showInClientPortal": true, "signed": { "expiresOn": 0, "signedUrl": "string" }, "url": "string", "visibleToRecord": true }, "jobType": "string", "languages": [ { "code": "string", "level": { "code": "string", "name": "string", "orderNumber": 0 }, "name": "string" } ], "location": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityNameLower": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryCodeLower": "string", "countryName": "string", "fullAddressLine": "string", "geoCodingLine": "string", "hasAddressLine": true, "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasCountryCode": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string", "shortAddressLine": "string" }, "openings": 0, "ownerId": "string", "ownerName": "string", "packageOverview": "string", "pay": { "candidateRate": 0, "currency": { "code": "string", "id": "string", "name": "string", "symbol": "string" }, "daysPerWeek": 0, "endDate": "yyyy-MM-dd", "endTime": "string", "hoursPerDay": 0, "jobEndDate": "string", "jobPayLabel": "string", "jobStartDate": "string", "label": "string", "maxPay": 0, "minPay": 0, "onCosts": 0, "payLabel": "string", "payRate": 0, "range": true, "startDate": "yyyy-MM-dd", "startTime": "string", "tenure": { "code": "string", "id": "string", "name": "string" } }, "postedOn": "dd/MM/yyyy", "publishToWebsite": true, "recruiter": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryName": "string", "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string" }, "aiAgent": true, "archived": true, "calendarColor": "string", "createdOn": "string", "disabled": true, "email": "string", "emailConnected": true, "fullName": "string", "headline": "string", "id": "string", "initials": "string", "languages": [ "string" ], "linkedIn": "string", "masterDataPrivileges": [ "string" ], "mobile": "string", "modifiedOn": "string", "modules": [ "string" ], "nickname": "string", "office": { "address": { "addressLabel": "string", "addressLine": "string", "addressLine2": "string", "cityName": "string", "cityOrRegionAndPostCode": "string", "cityRegion": "string", "country": "string", "countryCode": "string", "countryName": "string", "hasCity": true, "hasCityOrRegion": true, "hasCountry": true, "hasPostcode": true, "hasRegion": true, "hasValidGeo": true, "latitude": 0, "longitude": 0, "postCode": "string", "regionName": "string" }, "id": "string", "name": "string", "phone": "string" }, "privileges": { "anonymise": true, "bulkEmail": true, "bulkSms": true, "deleteData": true, "deleteEmails": true, "exportData": true, "invoiceReconciliation": true }, "profilePicUrl": "string", "role": "string", "teamId": "string", "teamName": "string", "timeZone": "string", "twoFactorEnforced": true, "uniqueId": 0, "workPhone": "string" }, "recruitingTeam": { "members": [ { "email": "string", "id": "string", "initials": "string", "name": "string", "owner": true, "profileImageUrl": "string", "role": "string" } ] }, "reference": "string", "remoteWorking": true, "scorecardTemplate": { "createdOn": "string", "generatedFrom": "string", "groups": [ { "attributes": [ { "id": "string", "label": "string" } ], "category": "string", "name": "string" } ], "modifiedByUserEmail": "string", "modifiedOn": "string" }, "sector": "string", "sectors": [ { "category": "string", "color": "string", "createdBy": "string", "id": "string", "masterDataType": "string", "message": "string", "name": "string", "position": 0, "reasons": [ { "defaultReason": true, "id": "string", "name": "string", "orderNumber": 0, "statusId": "string" } ], "success": true, "synonyms": [ "string" ], "tenantId": "string", "type": { "code": "string", "id": "string", "name": "string" }, "userName": "string", "values": [ "string" ] } ], "shortDescription": "string", "skills": [ "string" ], "status": "string", "tags": [ { "key": "string", "value": "string" } ], "tenantId": "string", "title": "string", "uniqueId": 0, "webAdvert": { "coreSkills": "string", "keyLanguages": "string", "mainResponsibilities": "string", "recruitmentProcess": "string", "whatWillYouLearn": "string", "whatsOnOffer": "string" }
{
}
Get record by ID
GET
/api/nova/records/{recordId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
recordId*
recordId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { }, "error": "string", "message": "string", "success": true
{
}
List open tasks
GET
/api/nova/tasks/list
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
page
page
Type
integer
Format
"int32"Default
0size
size
Type
integer
Format
"int32"Default
20Responses
OK
application/json
JSON "data": [ { "additionalProperties": { } } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Get task by ID
List all users
GET
/api/nova/users/list
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": [ { "active": true, "email": "string", "firstName": "string", "id": "string", "jobTitle": "string", "lastName": "string", "mobile": "string", "role": "string" } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
Get current user from API key
GET
/api/nova/users/me
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "active": true, "email": "string", "firstName": "string", "id": "string", "jobTitle": "string", "lastName": "string", "mobile": "string", "role": "string" }, "error": "string", "message": "string", "success": true
{
}
Get user by ID
GET
/api/nova/users/{userId}
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
userId*
userId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "active": true, "email": "string", "firstName": "string", "id": "string", "jobTitle": "string", "lastName": "string", "mobile": "string", "role": "string" }, "error": "string", "message": "string", "success": true
{
}