Utility Endpoints

A series of endpoints for miscellaneous interactions with the API

GET {root}/heartbeat

A very simple endpoint to test connection to the API

GET {root}/authtest

Test your authentication to the API. Returns some simple details about the tenant.

GET {root}/integrationtest

Returns basic details about the integration being used to connect to the API (see API/Integrations).

GET {root}/tecfg

Returns the complete Tenant Editable Config (TECFG) object for the tenant. This is referred to as 'Account Settings' in the admin panel.

POST {root}/parseaddress

Parse an address string into a semantic address object. The request should contain a field address.