Quickstart

Get from zero to your first API call in about five minutes. The Pinlyx Public API gives you programmatic access to your contacts, Telegram messaging, sales pipeline, tasks, finance, and email inbox.

All requests go to the production host:

https://api.crmsolid.com

Every request must include an Authorization: Bearer <token> header, where the token is a Pinlyx API key. Keys use the format csk_live_<keyId><secret> — for example csk_live_xxx.

Note

Your secret key is shown only once, at creation time. Store it somewhere safe and never commit it to source control. See Authentication for full details on key formats, scopes, and rate limits.

Get started

1. Create an API key.

   Open the Pinlyx app at app.crmsolid.com and go to Settings → Developers. Create a new key and grant it the scopes you need (for example contacts:read or telegram:send). Copy the full csk_live_… value immediately — the secret is only shown once.

2. Make your first request.

   Verify your key by calling GET https://api.crmsolid.com/v1/me. This returns the workspace identity associated with the key and is the simplest connectivity smoke-test — any valid key may call it, no specific scope required.

   cURL

   curl -s https://api.crmsolid.com/v1/me \
     -H "Authorization: Bearer csk_live_xxx"

   JavaScript

   // Native fetch in Node 18+ (or `import fetch from 'node-fetch'`)
   const res = await fetch('https://api.crmsolid.com/v1/me', {
     headers: { Authorization: 'Bearer csk_live_xxx' },
   });
   const data = await res.json();
   console.log(data);

   Python

   import requests
   
   r = requests.get(
       "https://api.crmsolid.com/v1/me",
       headers={"Authorization": "Bearer csk_live_xxx"},
   )
   print(r.json())

   A successful response looks like this:

   {
     "id": 42,
     "email": "jane@example.com",
     "name": "Acme Inc.",
     "createdAt": "2024-01-15T09:00:00Z",
     "apiKey": {
       "keyId": "abc123def456",
       "scopes": ["contacts:read", "telegram:send"]
     }
   }

3. Send a Telegram message.

   With a key that has the telegram:send scope, enqueue an outbound Telegram message via POST https://api.crmsolid.com/v1/telegram/messages. The recipient is resolved from contactId, username, or telegramUserId — supply at least one. The accountId must be one of your connected Telegram accounts. The request returns immediately with the queued job (202 Accepted); the background worker delivers it.

   cURL

   curl -s -X POST https://api.crmsolid.com/v1/telegram/messages \
     -H "Authorization: Bearer csk_live_xxx" \
     -H "Content-Type: application/json" \
     -d '{
       "accountId": 7,
       "username": "john_doe",
       "text": "Hi from Acme Inc.!",
       "runAt": null
     }'

   JavaScript

   const res = await fetch('https://api.crmsolid.com/v1/telegram/messages', {
     method: 'POST',
     headers: {
       Authorization: 'Bearer csk_live_xxx',
       'Content-Type': 'application/json',
     },
     body: JSON.stringify({
       accountId: 7,
       username: 'john_doe',
       text: 'Hi from Acme Inc.!',
       runAt: null,
     }),
   });
   const job = await res.json();
   console.log(job);

   Python

   import requests
   
   r = requests.post(
       "https://api.crmsolid.com/v1/telegram/messages",
       headers={"Authorization": "Bearer csk_live_xxx"},
       json={
           "accountId": 7,
           "username": "john_doe",
           "text": "Hi from Acme Inc.!",
           "runAt": None,
       },
   )
   print(r.json())

   Tip

   Set runAt to a UTC timestamp to schedule delivery for later, or leave it null (or omit it) for immediate dispatch. To track delivery, poll GET /v1/telegram/messages/{id} with the returned job id.

Next steps

• Authentication — key formats, scopes, and rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset).
• API reference — the full list of endpoints for contacts, messages, deals, tasks, finance, and email.