Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
company

Get Document Folders

Use this endpoint to get the document folders for a company. This endpoint will return a paginated response starting from the given record index.

get/company-settings/job-file-settings/document-folders

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
recordStartIndexinteger

The index of the first element to return

sortOrder'Ascending' | 'Descending'

return jobs in Ascending (default) or Descending order

Response

OK

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

Example response

{
  "items": [
    {
      "documentFolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Folder Name",
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}