June 26, 2019
Ontraport is proud to announce our new API!

Over the last few years, the Ontraport platform has radically transformed, and we’re on the top of our game. With the arrival of our new Custom Objects feature and the flexibility it offers our users, we thought “What better time to unveil our new functionality to our API users?”.

In addition to providing up-to-date documentation of API specifics (endpoints, parameters, etc.), with the new Ontraport API, you can interact with your Ontraport account within the documentation itself!

Significant enhancements include:

  1. Upgrade from XML response data format to the more web-native JSON format
  2. More RESTful HTTP request support, as well as proper HTTP response codes
  3. Use of the Swagger API Framework for an intuitive UI and live testing of creds

To get started, visit our new API documentation center and enter your App ID and API Key at the top of the page. The glowing green input fields indicate a valid entry. After your keys authenticate, you’re ready to interact with the API.

Check out this simple, yet handy request to fetch a list of all existing Object types: https://api.ontraport.com/doc/#!/objects/getMeta. The parameters belonging to this endpoint are optional are optional, so go ahead and click “Try it out!”  You’ll see the Request URL used by Swagger UI to perform the API request as well as Ontraport’s response.

This is just one of many examples of the requests you can make from your software and the response you can expect from Ontraport. Tinker with the rest on our API Docs here.

In the coming months, we’ll be expanding the available API endpoints as well as documentation of existing endpoints.

As it stands, we have no plans to stop servicing requests to existing APIs, but we strongly encourage adoption of this new API for any new integrations with Ontraport. To aid adoption of the new API, we’re providing links to new API endpoints that mimic old API functionality in the old API documentation. See Forms API, Payments API, Contacts API, and Products API.

Let us know what we can do to support you and your integrations so we can continue to feed the community, push the limits of our software and make it as versatile as possible. Your feedback can help prioritize additional functionality and let us know where documentation is lacking. We’re excited to see how our clients use the new API!

About Pin Chen
Pin Chen is Chief Technology Officer at Ontraport. One of the three original Ontraport employees, Pin began work at entrepreneur Landon Ray’s real estate marketing company straight out the University of California, Santa Barbara, where he graduated with a BS in Computer Science. Almost ten years later, Pin brings technical and interpersonal acumen to Ontraport.