Introduction

The Woodpecker API provides a RESTful infrastructure that allows you to manage your account, prospect list, campaigns, reports, mailboxes, and client accounts as an agency. Our goal is to create an API that enables full external management of your and your client's Woodpecker accounts. If you have any suggestions, feel free to reach out to us at developers@woodpecker.co.

Prerequisites

Access to the API is a part of the API keys & integrations add-on. You can check your access in the marketplace. This feature is also available to all trial users.

Support

This documentation focuses on the Woodpecker API to help you connect with external tools or build your own integration. For queries related to the API, please contact us at developers@woodpecker.co. If you need help regarding the application functionalities and any non-API related topics, please visit our Help Center.

Base URL

The base URL for all endpoints is https://api.woodpecker.co/rest

Authentication

All requests must be authenticated using an API key in the x-api-key header. Read more here.

Rate limiting

Rate limits are in place to maintain reliable API access for all users. Read more here

Account scopes

Our API provides account-level endpoints accessible to all users. Additionally, enabling the Agency add-on grants access to endpoints dedicated to managing multiple client accounts at the agency level.