Introduction to the API

The Knack API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.

Our API follows most conventions of RESTful architecture. Any requests which require authentication must always be authenticated, as our servers do not retain information from previous requests. Our routes are reliably simple and require only a few levels of nesting.

All data sent to and from the API must be in JSON format. Many coding languages include utilities to convert data structures to JSON strings and vice versa.

We provide example API requests throughout the documentation. Each example is from the Contact Directory template app.

📘

You can add the Contact Directory Template app into your own account, but note that you will need to replace the placeholder header values and record IDs in these requests in order to get them working with your own apps.