Returns a list of document categories.

GET /people/document-categories

Group: People Management › Document Categories · Operation ID: documentCategories

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
name — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
label — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
requestable — 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, name, label, requestable, lastModifiedDate
Selectable: id, name, label, description, requestable, lastModifiedDate

200 Success

Under data, an array of documentCategoriesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the document category.
`name`	string or null	no	The internal name of the category. Absent when none is set.
`label`	string or null	no	The display label of the category. Documents filed under this category are named with it as a prefix. Absent when none is set.
`description`	string or null	no	A longer description of what belongs in this category. Absent when none is set.
`requestable`	boolean or null	no	Whether an employee may request a document of this category from HR, rather than the category only receiving uploads.
`lastModifiedDate`	string (date-time)	no	The date and time the category record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.