API reference

The PostFuze REST API is the unified way to publish to every supported platform from a single integration. Every endpoint shares one base URL, one authentication scheme and one set of conventions — so once you can call one resource, you can call them all.

Base URL

All requests are made over HTTPS to a single versioned base URL. There are no regional or per-platform hosts to manage.

Base URL
https://api.postfuze.com/api/v1

Authentication

Authenticate every request with a PostFuze API key passed as a bearer token. Keys are scoped to a single org and come in sk_live_… and sk_test_… variants. PostFuze stores only a hash, so copy a key when it is created — it cannot be retrieved again.

Authorization header
Authorization: Bearer sk_live_…

See Authentication for creating, rotating and revoking keys.

Versioning

The API is versioned in the path (/api/v1). Backwards-compatible changes — new endpoints, new optional fields, new enum values — ship within a version without notice, so write tolerant clients. Breaking changes ship under a new version prefix and the previous version keeps running during a documented deprecation window.

Requests & responses

Requests and responses are JSON. Send Content-Type: application/json on any request with a body. All resource IDs are opaque strings and all timestamps are ISO 8601 in UTC. List endpoints share the same cursor-based scheme described in Pagination & filtering, and write endpoints accept an Idempotency-Key header so retries are safe — see Idempotency.

Errors & rate limits

Failures return a structured problem object with a stable code, a conventional HTTP status, and a human-readable message. Read Errors for the full code catalog and Rate limits & retries for the limit headers and the recommended backoff strategy.

Resources

Each resource below has its own reference page with endpoints, request and response shapes, and examples.