API Reference

The ReachScore API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://api.reachscore.co/v1

Authentication

Authenticate your API requests by including your API key in the Authorization header:

curl https://api.reachscore.co/v1/tests \
  -H "Authorization: Bearer rk_live_your_api_key"

See Authentication for more details on API key types and scopes.

Endpoints

Tests

Create and manage email deliverability tests

POST/tests

GET/tests

GET/tests/{id}

Domains

POST/domains

POST/domains/{id}/verify

GET/domains/{id}/health

Monitors

Scheduled automated testing

POST/monitors

GET/monitors/{id}/results

Webhooks

Real-time event notifications

POST/webhooks/endpoints

GET/webhooks/endpoints/{id}/deliveries

Alerts

Score threshold notifications

POST/alerts

GET/alerts/{id}/history

Reports

Analytics and shareable reports

GET/reports/summary

GET/reports/trends

POST/reports/share

Team

Manage members and invitations

GET/team/members

POST/team/invitations

API Keys

Create and revoke API keys

POST/keys

DELETE/keys/{id}

Billing

Subscriptions, usage, and invoices

GET/billing/usage

POST/billing/checkout

Errors

ReachScore uses conventional HTTP response codes to indicate the success or failure of an API request. See the Errors page for details.

2xx

Success

4xx

Client error

5xx

Server error

Pagination

List endpoints use cursor-based pagination. Use the starting_after parameter with the ID of the last item to get the next page.

# Get first page
curl "https://api.reachscore.co/v1/tests?limit=20"

# Get next page
curl "https://api.reachscore.co/v1/tests?limit=20&starting_after=test_abc123"

Rate Limits

Rate limits vary by plan. Every response includes rate limit headers:

Header	Description
RateLimit-Limit	Max requests in current window
RateLimit-Remaining	Remaining requests
RateLimit-Reset	Unix timestamp when window resets

See Rate Limits for plan-specific limits.

Start with Tests API