Quickstart
Make your first authenticated request in a couple of minutes.
Authentication
Generate an API key and scope it to what your integration needs.
Base URL
The Audienceful API is located at:v2 is the current API and all new integrations should use it. Every request is authenticated with an API key in the X-Api-Key header.Core concepts
Before you write your first request, it’s worth skimming the shared conventions that apply across every endpoint.Rate limits
Per-workspace limits and rate headers
Errors
The single error envelope and error types
Idempotency
Safely retry POST requests
Pagination
Cursor pagination for list endpoints
Resources
Build your own solution for growing and managing your audience. We’re continually adding functionality to the public API as we ship improvements and new features.People
Manage your contacts programmatically
Fields
Retrieve and create your custom fields
Audiences
List your audiences and their member counts
Automations
Trigger automation events for a contact
Transactional Email
Send a draft to one recipient on demand
Send Reports
Read send reports for completed email sends
Webhooks
Get notified when things happen in a workspace
Request Logs
Audit your workspace’s recent API activity
Can’t find an endpoint for what you need? Let us know and we’ll make it available as soon as possible.
OpenAPI & SDKs
A machine-readable OpenAPI 3 schema covering the public v2 endpoints is served at https://api.audienceful.com/v2/openapi.json. Use it to generate a typed SDK in your language of choice, import the API into Postman or Insomnia, or keep your own reference in sync.OpenAPI schema
The full machine-readable v2 spec
Support
Find guides and get help with the product