Version: 5.3.3
Authentication Guide
Try Contacts API
Webmecanik Automation API
Complete REST API reference for Webmecanik Automation — manage contacts, campaigns, emails, segments, and more programmatically. All endpoints are available under the /api path of your instance.
Quick Start
1. Get your credentials
Create API credentials in Settings → API Credentials in your instance. You'll get a Client ID and Client Secret.
2. Get a token
curl -X POST https://{domain}/oauth/v2/token \
-d "grant_type=client_credentials" \
-d "client_id={id}" \
-d "client_secret={secret}"
3. Make API calls
curl https://{domain}/api/contacts \
-H "Authorization: Bearer {token}"
API Endpoints
Contacts
CRUD, batch, activity, DNC, UTMCompanies
Manage companies & associationsSegments
Smart lists & contact membershipCampaigns
Campaign management & eventsEmails
Create, send & track emailsForms
Forms & submission dataStages
Lifecycle stage managementPoints
Scoring, triggers & groupsTags
Tag managementCustom Objects
Custom data & relationshipsUsers
User & role managementWebhooks
Event notifications
CRUD, batch, activity, DNC, UTMCompanies
Manage companies & associationsSegments
Smart lists & contact membershipCampaigns
Campaign management & eventsEmails
Create, send & track emailsForms
Forms & submission dataStages
Lifecycle stage managementPoints
Scoring, triggers & groupsTags
Tag managementCustom Objects
Custom data & relationshipsUsers
User & role managementWebhooks
Event notifications
Key Concepts
| Topic | Description |
|---|---|
| Authentication | OAuth 2.0 — Client Credentials and Authorization Code flows |
| Error Handling | Standard error format and HTTP status codes |
| Rate Limiting | Request limits and rate limit headers |
| Pagination | start, limit, orderBy parameters for list endpoints |
| Search & Filtering | Field-specific and free-text search |
| Batch Operations | Create, edit, delete up to 200 records per request |
Content Types
| Endpoint | Request | Response |
|---|---|---|
Token (/oauth/v2/token) | application/x-www-form-urlencoded | application/json |
| All API endpoints | application/json | application/json |