Documents

GET /people/documents

Group: People Management › Documents · Operation ID: documents

Returns a list of employee documents. Each entry is document details only. Fetch the file itself through GET people/documents/:id/download.

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
employeeId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
categoryId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
expiryDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, documentNumber, categoryId, status, expiryDate, lastModifiedDate
Selectable: id, documentNumber, employeeId, categoryId, categoryLabel, fileName, status, expiryDate, lastModifiedDate

200 Success

Under data, an array of documentsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the document.
`documentNumber`	string or null	no	The system-generated document number.
`employeeId`	string or null	no	The identifier of the employee the document belongs to. Absent when the linked employee no longer resolves. See id on GET people/:id.
`categoryId`	string or null	no	The identifier of the document category the document is filed under. Absent when the linked category no longer resolves. See id on GET people/document-categories.
`categoryLabel`	string or null	no	The display label of the document category the document is filed under. See label on GET people/document-categories.
`fileName`	string or null	no	The stored file name, generated on upload from the category label and the employee's name.
`status`	string or null	no	The current status of the document. Possible values: 'pending', 'approved', 'rejected', 'deprecated', 'readyToDownload', 'downloaded'.
`expiryDate`	string (date-time) or null	no	The day the document expires, projected as UTC midnight of that day. Format YYYY-MM-DDTHH:mm:ss.sssZ. Absent when the document does not expire.
`lastModifiedDate`	string (date-time)	no	The date and time the document record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.