API Reference

Gets metadata for the company root folder or a specific company document subfolder.

get
https://example.com/wep/companies//folders/

Access: System, Admin, and ClientAdmin users only.

When folderId is omitted, the endpoint returns the root folder assigned to the company. When it is supplied, the endpoint resolves that specific folder within the company document tree.

This endpoint returns folder metadata only. Use M:Worklio.ExtApi.API.Controllers.Document_v10Controller.GetFolderItems(System.Int32,System.Int32) to retrieve the child folders and documents stored inside the folder.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Identifier of the company whose document folder tree is being queried.

int32
required

Optional folder identifier. Omit the value to retrieve the company root folder.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain

Updated about 1 month ago