Column Selection

By default, all public fields are returned for each vacancy. To reduce payload size, pass a columns array in your request with only the fields you need.

Example

{
  "take": 20,
  "columns": ["id", "refNo", "role", "salaryFrom", "salaryTo", "startDate", "locationId"]
}

Available columns

Column	Type	Description
id	integer	Internal vacancy ID
refNo	string	Reference number (e.g. RS-1045)
role	string	Role/job title — primary display field
title	string	Secondary title field
description	string	Full job description
startDate	datetime	Role start date
endDate	datetime	Role end date
dateRegistered	datetime	Date vacancy was registered
durationInWeeks	integer	Duration in weeks
statusId	integer	Status ID
jobTypeId	integer	Job type ID
gradeId	integer	Grade ID
specialityId	integer	Speciality ID
locationId	integer	Location ID
salaryFrom	decimal	Minimum salary
salaryTo	decimal	Maximum salary
hourlyRate	decimal	Hourly rate
isDe	boolean	Is direct engagement
isComplete	boolean	Is complete
publicUrl	string	Public job posting URL
divisionId	integer	Division ID
departmentId	integer	Department ID
sourceId	integer	Source ID