CONVERTEC

DEVELOPERS

API Reference

Build custom integrations, sync data, and extend the Convertec platform with a clean, predictable REST API.

Authentication

Every request to the Convertec API must be authenticated with a Bearer token. Generate an API key from your workspace settings, then pass it in the Authorization header of every request.

  • API keys are scoped per workspace and can be restricted to read-only access
  • Bearer tokens rotate automatically every 90 days for security
  • OAuth 2.0 is available for third-party apps that act on behalf of users
  • All traffic is encrypted in transit with TLS 1.3
Example request
# Fetch your first 20 contacts
curl -X GET "https://api.convertec.cloud/v1/contacts?limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Response
{
  "data": [
    { "id": "ctc_8f2a", "name": "Jordan Lee", "email": "jordan@acme.co", "stage": "qualified" }
  ],
  "meta": { "count": 20, "has_more": true, "next_cursor": "eyJpZCI6IjhmMmEifQ" }
}

Endpoint categories

Every resource in the platform is reachable over a consistent, versioned REST API at api.convertec.cloud/v1.

Contacts

Create, search, and manage contact records

GET
/contacts

List all contacts with pagination and filters

POST
/contacts

Create a new contact record

GET
/contacts/{id}

Retrieve a single contact by ID

PUT
/contacts/{id}

Update an existing contact

Deals

Manage pipeline stages and deal values

GET
/deals

List all deals across pipelines

POST
/deals

Create a new deal and attach it to a pipeline

PUT
/deals/{id}/stage

Move a deal to a different pipeline stage

DELETE
/deals/{id}

Permanently remove a deal

Campaigns

Read and manage marketing campaigns

GET
/campaigns

List all active and archived campaigns

POST
/campaigns

Create a new campaign

GET
/campaigns/{id}/metrics

Retrieve performance metrics for a campaign

Analytics

Query aggregated performance data

GET
/analytics/overview

Account-level performance summary

GET
/analytics/revenue

Revenue attribution by channel

GET
/analytics/funnels/{id}

Conversion funnel breakdown

Webhooks

Subscribe to real-time platform events

GET
/webhooks

List all configured webhook subscriptions

POST
/webhooks

Register a new webhook endpoint

DELETE
/webhooks/{id}

Remove a webhook subscription

Team

Manage users, roles, and permissions

GET
/team/members

List all team members in the workspace

POST
/team/invites

Send a new team invitation

PUT
/team/members/{id}/role

Change a member's permission role

Rate limiting

To keep the platform fast and fair for everyone, API requests are rate-limited per workspace based on your plan tier.

Launch
60 requests / minute
Burst up to 120
Grow
300 requests / minute
Burst up to 600
Dominate
Custom limits
Dedicated throughput on request

Rate limit status is returned in the X-RateLimit-Remaining and X-RateLimit-Reset response headers on every call.

Official SDKs

Skip the boilerplate. Our client libraries handle authentication, retries, and pagination for you.

Node.js

npm install @convertec/sdk

TypeScript-first client with full type definitions for every endpoint.

Python

pip install convertec

Pythonic client with async support, built for data pipelines and automation.

PHP

composer require convertec/sdk

Compatible with Laravel and vanilla PHP 8.1+ projects.

Ready to build?

Request API access for your workspace and we will send you a key within one business day, along with sandbox credentials.