API reference

The API reference section of this documentation provides detailed information for each set of endpoints of the Ortto API, along with descriptions of all valid parameters, request body fields, and response body values.

The following top-level Ortto API entities/endpoints are available:

NOTE: Ortto customers who have their instance region set to Australia or Europe will need to use specific service endpoints relative to the region:

  • Australia: https://api.au.ap3api.com/
  • Europe: https://api.eu.ap3api.com/

For example: https://api.eu.ap3api.com/v1/<entity/endpoint>

All other Ortto users will use the default service endpoint (https://api.ap3api.com/).

Talk methods

The methods and events available to programmatically control the Talk messenger widget are described at Talk JavaScript API.