Autopilot developer documentation

The Autopilot application programming interface (API) lets you leverage Autopilot further by adding your own people, activities and other data, through Autopilot’s API.

This guide is aimed at developers who want to interact with Autopilot through its API.

This API deals specifically with interacting with your own "Autopilot Instance" (see below for the definition of that), rather than creating integrations with Autopilot which are available for all customers.

Terminology

There is some terms we will use frequently in the discussion of the Autopilot’s API and it will be easier if you just know what they are.

Autopilot Instance: when we refer to your Autopilot "instance", we mean your specific Autopilot account. So if you signed up for an account called "Bob’s Bees", your instance might be something like "bobsbees". We might also call this your Instance ID. It is possible for you to have more than one Autopilot instance, but using the API you would only interact with one at a time.

Instance ID: If you signed up for an account called "Bob’s Bees", your instance might be something like "bobsbees". This is used in all requests to the API and in all sorts of places, it is worth knowing your InstanceID and you can see it in the bottom left hand corner of the Autopilot interface when logged into your account.

About this documentation

Autopilot’s developer documentation (docs) is divided into the following sections:

  • Developer guide - this guide provides use-case instructions for developers on how to interact with Autopilot’s API.

  • API reference - this section of the developer docs provides a reference of all API endpoints available in Autopilot’s API, along with descriptions of all valid parameters, request body fields, and response body values.

 

If you are looking for documentation on how to interact with Autopilot through its user interface (UI), learn more in the Autopilot user guide.