v1

latestOpenAPI 3.1.02026-08-04150110.3 KB

Headcount

Generate headcount CSV and upload it to pigment

Generate the headcount CSV and trigger an async upload to Pigment. Optionally pass time-period in the body (currently only "this-year" is supported) to scope the CSV to the org's current fiscal year. Refer to the Pigment Connector API FAQ for more details.

post/{domain}/v1/headcount/upload/pigment

Path parameters

domainstring required

Request body

import-configuration-idstring required

time-period'this-year'

Filter records whose effective start date falls within the org's current fiscal year. Valid values: this-year.

Response

A success message describing the result of the upload.

string required