API Reference

This is the documentation for the REST APIs for Claromentis applications. Take a look at the 'Intro to REST' page if you need a refresher on the use of REST APIs. If you're just starting out you may also find the Getting Started page useful too.

The documentation aims to provide a full definition and working examples for the core framework APIs and all of the applications that have REST APIs. For some APIs there may be a tutorial available to give you and introduction and some sample code to start with in your own projects.

Core Claromentis Framework APIs

API	Description
Documents API	Read folders and documents.
Metadata API	Read system metadata.
People API	Read users.
People API v2	Read and modify users, groups, roles and extranets.
Search API	Search the system.
Trashcan API	View, delete and restore trash can items.

Application APIs

API	Description
Expenses API	Read objects from the Expenses module.
Knowledge Base API	Read and modify Knowledge Base articles, questions and categories.
Badges API	Read and modify Badges.
Thank You API	Read and modify Thank you notes and tags.
Learning API	Read Learning training records.