API Reference

Get Dependant Meta Data (POST)
This endpoint allows you to obtain the dependants current meta data values (or use -1 to get the structure) . POST /api/admin/metadata/values/get S...
Thu, 7 Aug, 2025 at 3:29 PM
Get Document Folders(Categories)
this endpoint allows you to get the list of folders belonging to a tenant. GET    /api/library/documents/folders/get/{tenantSubDomain:string} See...
Wed, 5 Jun, 2024 at 12:43 PM
Get Report
You can get the contents of a report via API with the following sample code. Below makes reference to  Platform This should be https://webapi.your plat...
Thu, 7 Dec, 2023 at 11:46 AM
Getting a Report List
This endpoint returns a list of tenant created reports on a platform.  The returned reports will be determined by the permissions/access of the API client....
Tue, 12 Dec, 2023 at 11:45 AM
Retrieve user's documents info
This endpoint returns a list of documents for the user.  The returned list will be determined by the permissions/access of the API client. GET api/libra...
Thu, 7 Dec, 2023 at 10:54 AM
Retrieving all dependant types for a Tenant
This endpoint returns a list of dependant types for the requested tenant.  GET    /api/static/dependants/types/get/{tenantId:int} Request U...
Mon, 13 Nov, 2023 at 3:56 PM
Retrieving all dependants for a specific employee
This endpoint returns a list of all dependants for an employee.  The returned list will be determined by the permissions/access of the API client. GET  ...
Thu, 7 Aug, 2025 at 4:08 PM
Retrieving the Gender List
This endpoint returns a list of all genders held on the platform.  The returned list will be determined by the permissions/access of the API client. GE...
Mon, 13 Nov, 2023 at 3:57 PM
Retrieving the Salutation List
This endpoint returns a list of all salutations.  The returned list will be determined by the permissions/access of the API client. GET    /api/static...
Mon, 13 Nov, 2023 at 3:57 PM
Soft Delete Dependant With Document
All API end points are protected and you will need a bearer token to send to the end point before you will be permitted access.  To obtain a bearer token yo...
Fri, 1 Aug, 2025 at 3:38 PM