API Reference

API Overview

Quickstart

  1. Get your Bespoke-API-Key under Settings > API Keys.
  2. Use Bespoke REST API
    • Use Curl or your language specific methods to do REST calls.
    • Make test calls with the new API collection in our Postman Workspace.
  3. Talk to Devs on Discord if you encounter any issue. We are here to help.

OpenAPI and Postman

Experience seamless integration with Bespoke's OpenAPI and Postman. Explore our latest OpenAPI specification.

For quick and convenient interaction with our APIs, import the OpenAPI spec into your preferred API tool, such as Postman. This will enable you to immediately begin working with our new APIs.

To further simplify your workflow, we have created a dedicated Postman Workspace. By visiting our Postman Workspace, you will have access to our latest collection of requests, along with the comprehensive API definitions.

🚧

The spec powers our documentation, and is kept up-to-date. However, it has not been officially tested for use with code-generation libraries. The spec is frequently updated and refactored as we continuously improve our reference documentation.

Leveraging the Bespoke API

Unlock the full potential of the Bespoke API with these informative guides:

  • Authentication: Discover comprehensive guidelines on authentication methods by visiting our dedicated Authentication guide.
  • Status Codes: Gain insights into error codes and their meanings by referring to our detailed Error Code guide.
  • Pagination: Optimize your API requests by understanding pagination techniques. Find in-depth information in our dedicated Pagination guide.
  • API Rate Limiting: Learn how Bespoke implements rate limiting to ensure smooth API usage. Get all the details in our informative Rate Limit guide.
  • Suppression Hit Tier: Explore how Bespoke effectively suppresses sending emails to users. Delve into the intricacies of this feature in our dedicated Suppression Hit Tier guide.

Maximize your usage of the Bespoke API by leveraging these valuable resources. Simply click on the corresponding links to access each guide and enhance your API integration experience.