ACacculynx
company

Get Document Folders

Changed on

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

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/company-settings/job-file-settings/document-folders
  • Auth
    HTTP bearer

Query parameters

pageSizeinteger

How many items to be returned at a time.

recordStartIndexinteger

The zero-based index of the first record to return.

sortOrder'Ascending' | 'Descending'

The sort direction for the results. Defaults to Ascending.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

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

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status