For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Quick Start

Authenticate with your own API key and make your first impact.com REST request in minutes.

Use this tutorial when you authenticate as a Brand, Partner, or Agency with HTTP Basic using an impact.com–issued token pair (Account SID and Auth Token).

To get started with the impact.com REST API, you'll need to mint credentials in impact.com and then call the REST API (https://api.impact.com/...) from software tools that your organization operates like a terminal + curl, Postman, or Python code.

1

Create an API access token

impact.com APIs expect HTTP Basic credentials (Account SID as username, Auth Token as password).

Follow Create an API Key to mint your token.

2

Store credentials securely

Never hardcode secrets in repositories. Only store secrets in a vault or in encrypted environment variables, never in source control or shared chats.

export IMPACT_SID="YOUR_ACCOUNT_SID"
export IMPACT_TOKEN="YOUR_AUTH_TOKEN"
3

Make your first API call (smoke test)

These examples call the campaigns endpoint with a GET query. You can make more detailed queries later via your persona REST reference pages.

curl --get \
  "https://api.impact.com/Advertisers/{AccountSID}/Campaigns" \
  -u "{AccountSID}:{AuthToken}" \
  -H "Accept: application/json"
import os
import requests
from requests.auth import HTTPBasicAuth

sid = os.environ["AccountSID"]
tok = os.environ["AuthToken"]
url = f"https://api.impact.com/Advertisers/{sid}/Campaigns"
r = requests.get(url, auth=HTTPBasicAuth(sid, tok), headers={"Accept": "application/json"})
print(r.status_code)
4

Verify you're authenticated

  • HTTP 200 (2xx) → success.

  • 401 → bad or missing SID/token pair.

  • 403 → good auth mechanics but persona path or scopes block the resource. Double-check Advertisers, MediaPartners, Agencies, plus token toggles.

  • 429 → slow down your requests. Add exponential backoff plus jitter inside scripts or agents.

For more detail, browse your persona docs linked from https://integrations.impact.com/llms.txt.

After you smoke-test, check Create an API Key for a detailed UI checklist, including scope toggles, API version pinning, rotations, duplication, disables, deletes, and legacy migration patterns.

Coming soon

OAuth 2.0 Authorization Code and PKCE flows for apps operating on behalf of many customers. Documentation will publish here alongside developer onboarding once available.

Last updated