API Previews

About

API previews allow you to preview new endpoints and changes to existing endpoints before they become part of the official ICE MT API library.

See a preview of the API contract including request and response samples and provide feedback before the contract becomes official in the coming months.

The API Explorer in Developer Connect will contain canned request and response samples, however, real time calls to the server will be disabled.

During the preview period, the APIs are still in development and contracts may change at any time. Once the API is made available for production use, we will announce it in the release notes for the given Encompass release, and the Preview" tag will be removed.

📘

Important!

API previews are meant for planning and feedback purpose only. Always refer to the generally available API contract for production use.

Where do I find API Previews?

API Previews are published in the same API Reference section as the rest of the generally available API collection, APIs in preview mode are denoted with a "Preview" tag.

We want your feedback!

Send us your suggestions for improving APIs in preview mode. Our goal is to ensure the APIs we develop meet your business needs.

  • Tell us your thoughts on the API Preview content, does the provided content give you enough information to get a head start in planning for integration?
  • What do you plan to use this API for?
  • Anything blocking your form using this API once its production ready?
  • Are there any additions or features you would find useful?

Email your feedback to [email protected]

APIs Currently in Preview Mode

The following V3 APIs are currently available in Preview mode.

eFolder Documents

User Pipeline View APIs