Integrate API
Build secure server-to-server integrations with Integrate to manage leads, lists, and reports.
X-API-Key and X-API-Key-SecretQuickstart
Keep your key and secret on your server. Every example on this site reads them from environment variables. Set those once, replace any ID placeholders at the top of an example, and it runs as written.
Store your key as environment variables
The examples read these three names. Your organization ID is your account ID, shown as ID on the Account admin > Overview page.
Make your first call
List the lists in your organization. A
200response with aresultarray means your key works.Or try it here
Choose Authorize at the top of the page and enter your key, secret and organization ID once; every endpoint's Try it then uses them. They are held only in this tab and never appear in the examples.
Errors
Most failures return JSON with an errors list of readable messages. Each endpoint page shows its exact error bodies. 401, and 403 for a role problem, come back with an empty body.
| Status | Meaning | What to check |
|---|---|---|
| 400 | The request is invalid. | The errors message names the field or rule. |
| 401 | The key and secret were not accepted. Empty body. | Send both headers, with a key from this site's environment that hasn't expired. A path or method that doesn't exist, or an ID in the path that isn't a GUID, also returns 401. |
| 403 | The key can't do this. | With an empty body: the key's role, or a feature that needs a paid license. With a detail message, or on Get organization an error object with code ERR8002: organizationId in the path isn't your key's account. |
| 404 | Nothing exists at this ID. | The ID, and that it belongs to your organization. |
| 415 | Wrong Content-Type. | Use the content type shown on the endpoint's page. |
| 422 | Submit lead only: the lead can't be processed. | The source ID, and that every required field of the source is present. |
| 5xx | Something failed on our side, or a service didn't answer (502, 503, 504). | Retry after a short wait. If it keeps failing, contact support@integrate.com with the time, the endpoint and the response. |