Skip to content

Credential Setup

Configure the LimeCrmApi credential before building any workflows. For credential naming standards, see Best Practices.

Lime CRM API

Used by the Lime CRM node and the Lime CRM Trigger node.

Required Fields

Field Value Notes
Server URL https://your-instance.lime-crm.com/your-database Include the database name. On Lime Cloud the database name matches the instance name.
API Key From Lime Admin See below
Webhook Secret Auto-generated Used to verify HMAC signatures on incoming webhooks

Where to Get the API Key

  1. In Lime Admin, go to System Settings → Security → Users.
  2. Create a new API user if one does not already exist.
  3. Select the user in the table and click Create API key.
  4. Copy the key immediately — it cannot be retrieved again after leaving the page.

Tip

Create one API user per workflow (or per integration), and configure the correct permissions on each. For example, one user that can only create and update companies, and a separate user for creating tickets.

Note

Creating a new API key overrides any existing key on that user.

How to Configure

  1. Go to Settings → Credentials → New credential.
  2. Select Lime CRM API.
  3. Enter the Server URL and API Key.
  4. Click Test to verify the connection.
  5. Save the credential.

Authentication

The credential injects X-API-Key: {key} on every request to the Lime CRM API.

Rate Limiting

Lime CRM Cloud enforces a rate limit of 3 000 requests per 5 minutes. Use bulk operations for large datasets to stay well within this limit.


Security Checklist

  • Never paste real API keys into workflow nodes, expressions, or sticky notes
  • Use a dedicated credential per environment (production, test)
  • Rotate API keys if there is any uncertainty about who has access to them
  • Store credentials only through the credential manager, never in workflow JSON files