Appearance
List master data
GET
/api/nova/masterdata
Returns all account-level master/configuration data in a single call, grouped by type: candidate, job, company, contact, lead, opportunity, placement and invoice statuses, company types, lead and opportunity pipelines, job pipeline stages and reject reasons, job application labels, recruiting team roles, activity types, sources, industries, sectors, skills, employment types, education levels and genders. Each item is lightweight and contains its id and name; leadStatuses and opportunityStates additionally carry pipelineId, pipelineName and typeCode (for example OPEN, WON or LOST), and each opportunity state lists its reasons as id and name pairs. Use these ids when creating or filtering records elsewhere in the API. All 23 lists are loaded in parallel and the response is privately cacheable for 5 minutes. The only required parameter is the apiKey; returns 401 if it is invalid.
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", "pipelineId": "string", "pipelineName": "string", "typeCode": "string" } ], "opportunityPipelines": [ { "id": "string", "name": "string" } ], "opportunityStates": [ { "id": "string", "name": "string", "pipelineId": "string", "pipelineName": "string", "reasons": [ { "id": "string", "name": "string" } ], "typeCode": "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", "requestId": "string", "success": true
{
}