Skip to main content

Find or rotate your REST API key

Learn how account admins can enable REST API access, copy an API key, and rotate it when a key needs to be replaced.

Written by Catherine Makena

Accessing your LeadSimple REST API key

The LeadSimple REST API lets you connect LeadSimple with third-party tools, build custom integrations, automate workflows, and access account data programmatically.

Account admins can enable REST API access, copy the current API key, and rotate the key from Settings. Non-admin users cannot view or rotate the key.

Before you start

  • You must be an account admin in LeadSimple.

  • Keep your API key private. Anyone with the key can read and change your account data through the API.

  • If your key may have been shared, exposed, or added to source control, rotate it as soon as possible.

Enable REST API access

  1. Log in to LeadSimple.

  2. Go to Settings.

  3. Select Integrations.

  4. Open the REST API card.

  5. If access is not enabled yet, select Enable REST API access.

After access is enabled, your REST API key appears on the page. You do not need to contact Support to enable REST API access if you are an account admin.

Find and copy your API key

  1. Go to Settings > Integrations > REST API.

  2. Find the Your REST API key section.

  3. Use the copy field to copy the key.

  4. Add the key to the third-party integration or custom workflow that needs API access.

The page shows when the key was created. If the key has been rotated before, it also shows the last rotated date.

Rotate your API key

Rotate your key if you believe it was exposed or when your security process requires a new key.

  1. Go to Settings > Integrations > REST API.

  2. Select Rotate API key.

  3. Review the confirmation warning.

  4. Select Rotate key to confirm.

  5. Copy the new key and update every integration that used the old key.

Important: Rotating the key immediately invalidates the current key. Any integration using the old key will stop working until you update it with the new key. This cannot be undone.

API reference

Use the API reference link on the REST API page, or open https://app.leadsimple.com/api_docs, to view REST API endpoints and request details.

Need help?

If you are not an account admin, ask an account admin on your team to enable access or rotate the key. If you are an admin and the REST API page does not work as expected, contact support@leadsimple.com.

Did this answer your question?