API

```mediawiki

API

Getting started with the API

The ActiveCampaign API is used to enable integrations between your ActiveCampaign account and third-party services or a custom interface you created.

What is an API?

API is short for Application Programming Interface and it allows for one application to talk to another. We recommend using the ActiveCampaign API for any functionality needed outside of the main user interface, such as enabling an integration.

How to obtain your ActiveCampaign API URL and Key

To enable an integration between your ActiveCampaign account and a third-party application, you need to obtain your API URL and Key. The API URL and Key can be considered your username and password, which third-party apps can use to access your ActiveCampaign account.

Each user in your ActiveCampaign account has their own API URL and Key. If integrations are set up with a user’s API credentials, deleting the user will cause integrations to break. Since there is no account default API, you must update affected integrations with another user's API credentials.

Your ActiveCampaign API URL and Key are located on the Developer Settings page in your account:

1. Click "Settings" (gear icon).
2. The Account Settings menu will appear. Click the "Developer" option.
3. Copy and paste your API URL and Key into your third-party application.

How to reset your API information

If your API information has been compromised, you can reset your key on your account's Developer Settings page. To reset your API information:

1. Click "Settings" (gear icon).
2. The Account Settings menu will appear. Click the "Developer" option.
3. Navigate to the Developer Settings page.
4. Click the "Reset API Key" button.
5. A confirmation window will appear. Click "Reset API Key" to confirm the change.

Note that you must update all third-party applications with your new API information.

API for Developers

With the ActiveCampaign API, you can sync contact information, view contact information, add contacts to automations, create and send campaigns, and more. Our API is structured around REST, HTTP, and JSON and requires basic authentication (actual user account within the software or a valid API URL and Key).

To work with our API, you’ll need the following:

• Valid ActiveCampaign account (a trial version will also work)
• Experience with creating custom-coded solutions and/or integration with REST APIs
• Ability to submit HTTP requests from your server

We provide a list of available API methods, detailed descriptions of each parameter, and examples in actual code. Our community forum is a great resource as you learn how the API works. There, you can interact with other developers and ask questions about the API. In addition, we have certified consultants who can assist you with your API needs.

Troubleshooting the API for Developers

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

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

While we'll do our best to help you troubleshoot your API issues, this can provide certain challenges. This is because we can't see what is happening with your application, script, or environment.

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

If you need assistance configuring something using the API, we recommend working with one of our certified consultants or posting in our community forum.

See Also

• Getting started with the API

```