MyWorkPal

this endpoint allows you to get the list of folders belonging to a tenant.

GET    /api/library/documents/folders/get/{tenantSubDomain:string}

See How to create API Clients to see how to obtain API Client IDs and secrets

Request

Url Params

tenantSubDomain

string

the subdomain of the desired tenant

Authorization

The following authorization header is required.  The authorisation header should be set to a 'Bearer Token' type

Token

see How to get a bearer token

Response

The response will return an array of 0 to n JSON objects.  Each JSON object in the array contains the following properties:

userDocumentFolderCategories	array	folder category list as an array
userDocumentFolderCategories.id	int	the folder/category id from the system
userDocumentFolderCategories.name	string	the system name of the folder/category
userDocumentFolderCategories.displayName	string	the friendly name/label of the folder/category
id	int	the id of the tenant folder config (internal)
tenantId	int	the tenant id
rootFolderId	int	root folder reference if not implementing custom folders
userDocumentFolders	array	the default folder list as an array if custom folders not in use

Permissions

The API Client requires access to the platform

Examples

C# Example

var client = new HttpClient(); 
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/api/library/documents/folders/get/{tenantSubDomain}");
request.Headers.Add("Authorization", "Bearer {access token}"); 
var response = await client.SendAsync(request); 
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

cURL Example

curl --location 'https://{platform API url}/api/library/documents/folders/get/{tenantSubDomain}'

' \ --header 'Authorization: Bearer {access token}'