API v2 overview

The SendStreak REST API v2 is the current, full-surface programmatic interface to SendStreak: everything you can do on the dashboard - contacts, transactional messages, events, templates, automations, announcements, topics, mail servers, send domains, webhooks - is available as a versioned JSON API.

Base URL

https://api.sendstreak.com/v2

All requests and responses use JSON (Content-Type: application/json). Dates are ISO 8601 strings, and resource identifiers are opaque strings carried in the _id field.

Account-scoped paths

Almost every endpoint lives under an account (workspace) path prefix:

https://api.sendstreak.com/v2/accounts/{accountId}/...

Your token can act on every account its owner is a member of. See Authentication for how to authenticate and how to find your accountId.

Conventions

  • Authentication - every endpoint requires a bearer token; see Authentication.
  • Pagination - list endpoints return an { items, start, limit } envelope and have a /count companion; see Pagination.
  • Errors - non-2xx responses share a common error body; see Errors and rate limits.
  • Secrets are write-only - signing secrets, SMTP passwords, and token values are accepted on write but masked on every read.

Endpoint reference

Every v2 endpoint has its own reference page - use the sidebar on the left, where endpoints are grouped by resource. If you are sending your first transactional email, start with Send a transactional message, Upsert a contact, and Record a contact event.

What about v1?

The v1 endpoints keep working for existing integrations, but new integrations should use v2. The legacy pages remain available under REST API v1.