You’re a “hands-on” kind of guy (or gal)? Then the easiest way to get started with the Lucca API is with our playground.

Learn how to use the playground

Read a quick guide about how to use the HoppScotch playground to test out the Lucca API.
 If you’d rather read about the features of the Lucca API first, then here are some must-read articles.

Learn how to authenticate to the Lucca API

Declare your client application, then generate access tokens.

Make sure you pick an API version

Each HTTP request must target an API version in the Api-Version HTTP header.

Create a sandbox environment

You wouldn’t want to test your integration on production data, now, would you?

Browse our guides on common use-cases…

There may already be a guide that gives you pointers about how to achieve what you want.

… or browse the API reference

Find the API endpoint you’re interested in and learn what you can do with it.

Want to be notified of changes? Read about webhooks.

You don’t want to poll the API to get updates? Deploy a webhook endpoint and subscribe the Lucca API events.