API Documentation
Introduction
IndiePitcher REST API documentation
Welcome
IndiePitcher REST API allows you to send emails, manage your contacts, and generate portal session to manage user’s contact lists.
Please note that most destructive operations are currently not supported through the REST API for sesucurity reasons. Please use the IndiePitcher dashboard.
Base URL
All requests contain the following base URL:
https://api.indiepitcher.com/v1
Authentication
- Create a free account at IndiePitcher to get your API key. API keys are tied to a project.
- After you’ve generated your API key you can use it to authenticate your requests by including it in the
Authorization
header.
Authorization: Bearer sc_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
Do not expose the API key and make calls to our API from your frontend code. You risk your API key being exploited by spammers and us having to reset/disable your API key.
Rate Limits
Rate limits are applied to all requests to the IndiePitcher API. The rate limits are as follows:
- 10 requests per second across API keys tied to a project.
After reaching the rate limit, you will receive a 429 Too Many Requests
response. The rate limit will reset after 1 second. We recommend using endpoints that support batch operations to reduce the number of requests made.
SDKs
SDKs are available for the following languages:
- Swift (server-side usage only)
OpenAPI spec
Quick Start Guide
Send a simple email
curl --request POST \
--url https://api.indiepitcher.com/v1/email/transactional \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"to": "john@acme.com",
"subject": "You have been invited to IndiePitcher",
"body": "This is a sample body that supports **markdown**. Plain html is also supported.",
"bodyFormat": "markdown"
}'