Skip to main content
POST
Export the employees a search matches as a CSV

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Headers

Request-Id
string

Optional. Your id for this request: it is carried into every log line about it, so quote it when you contact support.

Body

application/json

The columns, and which employees to export

A CSV of the employees a search matches, written in the background.

columns
object[]
required

The file's columns, in order, each a field your role can read, or an import column whose fields your role can read.

search
object | null

Which employees and in what order, as POST /employees/search takes it; every employee when omitted. Its fields, limit and offset are not used: the columns choose the fields and every match is written.

Response

Export started

message
object
required

A readable message about the outcome and a stable token a client can branch on.

content
object

The data the request returns with its metadata; left out on a response that carries no data, such as most errors.

validationIssues
object[] | null

Each field the request was refused for and why; left out when the request was not refused for its fields.