Build secure integrations with DinamikCRM and connect external systems to your CRM data.
Status
Operational
Check API availability using /api/v1/health.
Authentication
API Key + Secret
Protected requests use X-Api-Key and X-Api-Secret headers.
Documentation
OpenAPI + Scalar
Interactive documentation automatically follows the available API endpoints.
Capabilities
What You Can Build
Use the DinamikCRM API to integrate external applications with core CRM records and workflows.
Customers
Manage customer records
List, retrieve, create, update and delete customer records together with related contact information.
Leads
Work with lead data
Create and manage leads together with phone, email and address records.
Opportunities
Manage sales opportunities
Read, create and update customer-related sales opportunities.
Activities
Track CRM activities
Create and manage activities associated with customer records.
Products
Manage product data
Read product records and synchronize existing price and stock information.
Integrations
Connect external systems
Build secure tenant-scoped integrations without exposing internal database identifiers.
Limits & Usage
API Limits
Design your integration with the following usage limits in mind.
Authenticated Requests
100 / minute
Per authenticated API credential.
Unauthenticated Requests
20 / minute
Per IP address for unauthenticated or invalid requests.
Request Body
1 MB maximum
Requests exceeding the maximum body size are rejected.
Request Timeout
30 seconds
Requests exceeding the configured timeout may return HTTP 504.
Rate Limit
HTTP 429
Respect the Retry-After response header before retrying.
Subscription
Active subscription required
Inactive, expired or not-yet-active subscriptions return HTTP 403.
Integration Guidelines
Recommended Usage
Follow these recommendations for reliable and supportable integrations.
Rate Limits
Respect Retry-After
Do not immediately retry requests after receiving HTTP 429.
Polling
Avoid unnecessary requests
Use appropriate synchronization intervals and avoid repeated requests for unchanged data.
Retries
Retry selectively
Do not automatically retry 4xx responses other than HTTP 429.
Authentication
Protect credentials
Store API credentials securely and never expose them in client-side applications.
HTTP Status Codes
Handle responses correctly
Use HTTP status codes to distinguish authentication, authorization, validation and server errors.
Diagnostics
Keep Correlation ID
Include X-Correlation-Id when reporting an API issue to support.