Support : API Guide
API Overview

The CoreTRM API uses the client data model to create a dynamic set of endpoints for each client.

Learning the API syntax is essential for configuring and extending CoreTRM as the API is used across the application including the View Builder, Interface Builder, Data Validation rules, and more.

Endpoints are provided to retrieve data for a specific object, to bulk retrieve data from several objects at the same time, and to perform bulk updates to one or more objects in the same unit of work.

The default instance includes an API Builder view which can be used to learn how to format API requests, to query adhoc data, or to format an interface retrieval to be used by another application.

There are 2 API builder tabs that can be used.

API Requests to build an API request to retrieve data from the API.

API Updates to build formatted JSON to post data updates to the API.

Back to top
Need More Assistance?

Please get in touch.

Chat with

CoreTRM