Skip to main content

Harmony Public API

The Harmony Public API lets your own code push contacts into Harmony and read them back.

Any Account can use the API with an API key. It currently covers four operations:

  • GET /api/v1/workflows lists your workflows.
  • POST /api/v1/contacts/bulk imports up to 1000 contacts and can enroll them into a workflow.
  • GET /api/v1/contacts lists and searches contacts.
  • GET /api/v1/contacts/{id} reads one contact.

More operations will be added one at a time. The API reference, in the top navigation, lists exactly what is available today.

Who it is for​

The API is for developers working on their own Account: syncing contacts from a CRM or data warehouse, or starting outreach from an internal tool. Each API key acts as the Harmony user who created it, inside that user's Account.

Building an integration that many Harmony customers install is not supported yet.

Limits​

The API has no published rate limits yet.

Next steps​

  • Quickstart: create a key and make your first call.
  • Errors: the error format and how to report a problem.