Getting started with the API

The ActiveCampaign API is recommended for any functionality needed outside of the main user interface. We provide a list of available API methods along with detailed descriptions of each parameter, as well as examples in actual code. Our community forum is a great resource as you're learning how the API works. There, you can interact with other developers and ask questions about the API.

Overview

The ActiveCampaign API is a REST implementation, and requires authentication (actual user account within the software, or valid API URL and key).

General requirements

  1. Valid ActiveCampaign account (a trial account will also work fine).
  2. Familiarity with programming concepts and practices.
  3. Ability to submit HTTP requests from your server.

Obtain API URL and key

The first thing you will want to do is obtain your API URL and Key.

Go to “My Settings” and select “Developer” from the left side menu:





Once you obtain these values, you can submit API requests. Look at our API documentation to see what parameters are required, and how they should be formatted.

Reset your API key

To reset your API key (for example, in the event that it has been compromised), click the “Reset” button under the Key field:



Click “Reset API Key” to confirm that you want to reset it:



Then click “Save Settings” at the bottom of the page. You will see a new API Key in the Key field.

Please note: once you reset your API key, all access will be denied until you update your applications to use the new key.

For an example of how our API methods are structured, please visit our API Methods Overview page.

If you are receiving script errors, missing data, or anything prohibiting you from fully using the API, please contact our support team and provide the following information:

  1. Full API request URL (including all parameters)
  2. If it's a POST request, your POST data
  3. The expected response/action
  4. The actual response received from the server, and action performed (if any)

If you have a more general question (such as how a particular API method works, or why your specific API request is not returning data), you might be better off posting the issue in our user forum where it is documented publicly so other users can help share their own experiences, and future users can learn from past experiences.

Have more questions? Submit a request