This endpoint returns a list of document categories for a specified tenant.  The returned list will be determined by the permissions/access of the API client.


GET    /api/library/documents/categories/get/{tenant_subdomainname}



Request


Url Params

tenant_subdomainname
string
the subdomain name of the tenant


Authorization

The following authorisation 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:


idintthe id of the tenant document category
isSystemboolwhether the category is part of the default system
hasUserDocumentsboolwhether the category can contain user documents
canUserUploadboolwhether the category allows user to directly upload documents into
namestringthe name of the document category
displayNamestringthe display name of the document category
alwaysShowboolwhether the category should always show on the client side even when empty
orderPriorityintpriority of the documents category


Permissions

The API Client requires at least readonly permissions to Tenant users documents to successfully retrieve results (See Admin User Roles for more details).  Only tenants that the API client has access to will be returned.


Examples


C# Example


var client = new HttpClient(); 
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/api/library/documents/categories/get/{tenatSubDomainName}"); 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/categories/get/{tenantSubDomainName}' \ --header 'Authorization: Bearer {access token}'