Connext REST API (1.0.0)

The Connext REST API lets you programmatically manage subscribers, send messages, schedule blasts, and view delivery logs for your organization.

All endpoints return JSON and use standard HTTP methods (GET, POST, PATCH, DELETE) with RESTful URL paths.

https://api.connext.ms/api/v1

All endpoints in this document are relative to this base URL.

Every request must include an API key in the Authorization header:

Authorization: Bearer cnxt_your_api_key_here

API keys are scoped to the user who created them. A key inherits the user's organization and permissions — it can only access data within that organization and is limited to the actions the user is allowed to perform.

Generating an API key

1. Log in to the Connext admin panel.
2. Navigate to Settings → API Keys.
3. Click Create API Key and give it a descriptive name (e.g., "CRM Integration", "Zapier").
4. Optionally set an expiration date. Keys without an expiration remain valid until manually revoked.
5. Copy the key immediately — it is only displayed once and cannot be retrieved later.

Managing API keys

From the API Keys settings page you can:

• View all keys for your organization, identified by the first 8 characters of the key hash.
• Deactivate a key to temporarily suspend access without deleting it.
• Reactivate a previously deactivated key.
• Delete a key to permanently revoke access.

Security best practices

• Store keys in environment variables or a secrets manager — never hard-code them in source code.
• Use separate keys for each integration so you can revoke one without affecting others.
• Set an expiration date for keys used in short-lived or third-party integrations.
• If a key is compromised, delete it immediately from the admin panel.

The API returns standard HTTP status codes:

Error responses include a JSON body:

{
  "message": "Description of what went wrong"
}

• GET (list) returns a JSON array of objects directly.
• GET (single) returns the object directly.
• POST returns 201 with the created resource.
• PATCH returns 200 with the updated resource.
• DELETE returns 204 with no body.
• Action endpoints (send, test, estimate, cancel) return 200 with an operation result.

List endpoints (GET /subscribers, GET /schedules, GET /logs) accept limit and offset query parameters.

GET /v1/subscribers?limit=25&offset=0