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
Create a candidate
POST
/api/nova/candidates
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
{
}
Search candidates
GET
/api/nova/candidates/search
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}
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}
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
Create a company
POST
/api/nova/companies
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
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
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}
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}
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
{
}
Create a contact
POST
/api/nova/contacts
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
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
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}
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}
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
{
}
Create a job
POST
/api/nova/jobs
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
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
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}
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}
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
Get activities for a record
GET
/api/nova/journal/{recordId}
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
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
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
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}
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}
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
Get all master data
GET
/api/nova/masterdata
Returns all master/configuration data grouped by type. Lightweight — only id and name per item.
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
{
}
Create an opportunity
POST
/api/nova/opportunities
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
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
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}
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}
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
Get pipeline candidates for a job
GET
/api/nova/pipelines/job/{jobId}
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": [ { "additionalProperties": { } } ], "error": "string", "message": "string", "page": 0, "size": 0, "success": true, "total": 0
{
}
List all placements
GET
/api/nova/placements/list
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": [ { "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
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}
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
{
}
List open tasks
GET
/api/nova/tasks/list
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
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
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}
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
{
}