Developers
Pinlyx has a public REST API for your contacts, messages, deals, tasks, email, social inbox and finance records, plus signed webhooks that tell your systems when something changes. AI assistants connect through the MCP server, which is open on every plan: read-only on Free, with change tools on Pro and up. API keys, the REST API and webhooks are included in the Business plan; see pinlyx.com/pricing.
What you can build
Section titled “What you can build”| Surface | What it does |
|---|---|
| REST API | Read and write workspace data over HTTPS with JSON. Versioned under /v1. |
| Webhooks | Receive a signed POST the moment a contact, message, deal, task, invoice or ad account changes. |
| MCP server | Let Claude, ChatGPT, Cursor or any MCP client search contacts, answer messages and manage ads. Sign in with Pinlyx on any plan, or use an API key on Business. |
| SDKs and packages | A .NET client, the MCP stdio bridge and an n8n community node. |
| Data API | Public social account data across seven platforms. A separate product with its own keys and bill. |
| Store integrations | ikas, Shopify and WooCommerce bring customers, orders and abandoned carts into the CRM. |
Base URL
Section titled “Base URL”Every REST and MCP request goes to:
https://api.pinlyx.comThe host keeps its original name on purpose so existing integrations keep working. It is the production API for Pinlyx.
Authentication in one paragraph
Section titled “Authentication in one paragraph”Create an API key in Settings › Developers › API keys in the Pinlyx app. A key looks like csk_live_ followed by 44 characters, belongs to one workspace, and carries the scopes you tick when you create it. Send it on every request as Authorization: Bearer csk_live_.... The full key is shown once. Each key has its own per-minute request budget, reported in X-RateLimit-* headers. Details are in Authentication.
Start here
Section titled “Start here”- API quickstart Create a key, call /v1/me and queue your first Telegram message.
- Authentication Key format, scopes, workspaces and IP allowlists.
- Errors and rate limits Status codes, the error body and the per-key request budget.
- SDKs and packages Official packages you can install today.
- Data API Social account data behind its own key and plan.
- Sync contacts Create contacts and page through the whole list.
- Send a Telegram message Queue a message and follow it until it is sent.
- API reference Every endpoint, parameter and scope.