Authentication

Authorize API requests with a team API key and secret.

The Pixelwand CRM API authenticates requests using a team API key and API secret. Every API key belongs to a single team, and any record created through the API is associated with that team automatically.

Generating an API key

You generate a key from the Team settings page in the CRM:

  1. Go to Teams and select your team.
  2. Open the API Keys tab in the sidebar (visible to team owners and admins).
  3. Click Generate New API Key.
  4. Optionally add a description (e.g. "Website Contact Form").
  5. Click Generate.
  6. Copy the API Key and API Secret — they are shown only once.

Permissions: Only team owners and admins can generate API keys.

Treat the API secret like a password. Never expose it in client-side code or commit it to a public repository. If a secret is leaked, revoke the key and generate a new one.

Authorizing a request

Send the key and secret with every request using these headers:

HeaderDescription
X-API-KeyThe team API key.
X-API-SecretThe matching API secret.

Example

curl -X POST https://crm.pixelwand.io/api/method/crm.api.leads.create_lead \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "name=Ada Lovelace"

If the key or secret is missing or invalid, the API responds with a permission error and does not create any record.

On this page