Skip to main content

Base URL

All API requests should be made to:

API Versioning

The API uses URL versioning. The current version is v1:

Authentication

Most endpoints require authentication via API key. See the Authentication guide for details.

Request Format

All request bodies should be JSON with the Content-Type header:

Response Format

All responses are JSON. Successful responses follow this structure:

Error Handling

Error responses include an error message and optional details:

HTTP Status Codes

Rate Limiting

When rate limited, you’ll receive a 429 response:

Pagination

List endpoints support pagination with page and limit query parameters:
Paginated responses include metadata:

Available Endpoints

Create Contact

POST /v1/contacts

Create Post

POST /v1/posts/{platform}

Receive Webhook

POST /v1/webhooks/receive/{key}