Skip to main content

About the Trail API

The Trail CRM RESTful API enables you to handle many core actions from within the CRM, such as creating contacts, updating fact find information, and managing opportunities. It’s designed to help you seamlessly integrate Trail into your systems and workflows, enabling automation and efficient data exchange across your various business tools.

Intended Audience​

This API is intended for New Zealand-based financial advisers and businesses that use Trail CRM. Our documentation is designed for teams with the technical capability to work with APIs. It is best suited for those using additional tools, platforms, or middleware where CRM data needs to be queried or manipulated in real time.

Learning about the Trail API​

Each API endpoint is detailed in the API reference section of this documentation. Before diving in we recommend that you first review the Core API concepts area to ensure you have a smooth experience setting things up.

API Data Structure​

In Trail all data is grouped under an organization, this represents the business customer of Trail, typically a FAP licence holder.

Within an organisation some core data concepts are:

  • Pipelines and opportunities
  • Profiles and contacts
  • Members (Trail users)

object-relationship-2

Pipelines​

Pipelines represent different business workflows, separated by the product category that is being advised on. Each pipeline has a series of stages, such as ‘New prospect’, ‘Application submitted’, ‘Commission received’. Opportunities move through these pipelines, and opportunity represents a piece of work, and ‘opportunity to deliver a service’ such as handling a client's policy renewal.

object-relationship-3

Profiles​

Profiles represent a client situation, a profile will often be a family or a business, and is the container for financial products and statement of position information, a contact; a person, company or trust, can be associated with many profiles.

Taking a closer look, the API can access many of the different object types under a profile that makes up a statement of position.

object-relationship-1

Note

Many objects are linked to both a profile, and to a contact, for example, an asset is owned by one or more contacts. The Trail CRM will ‘pull’ these objects into the statement of position for any profile that the contact is associated with. The API will not; if you search for assets by profile, you will only see the assets that directly belong to that profile, not ones that have been pulled across from another profile with a contact.

Members​

Members are the Trail users under an organisation, typically advisers and assistants, each member has a Trail account.