v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Department

Retrieves the collection of Department resources.

Retrieves the collection of Department resources.

get/departments

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Department collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

namestring
directorystring nullable

List the directory of the current department e.g. Parent:Department1:SubDepartment1:SubDepartment2

subDepartmentboolean nullable

Boolean on if this department is a subdepartment

activeboolean

Boolean on if department is currently active

createdstring date-time nullable

Date entry was created

modifiedstring date-time nullable

Date entry was last modified

Example response

[
  {
    "integration": "quickbooks"
  }
]