How to test API in a local instance

To test API in your local instance, you have the following pre-requisites:

  1. repo clone. You can get it by following the instructions provided in Installation

  2. A staging license key that goes in as value for CALCOM_LICENSE_KEY in your root .env file.

    1. To get the staging license key, please proceed to create a dev account on

    2. Next, click on New Deployment

    3. Then, click on Next with Self-hosted selected

    4. Next, type in your deployment name as you like

    5. Finally, you would be taken to the test Stripe payment page. This is where you enter the Stripe test card information. So, simply enter 4242 4242 4242 4242 as the card number, fill the rest as you wish and finish the payment step.

      Once this is done, you will be redirected to your deployments page containing the list of your deployments. You can then click on the newly created deployment to copy the license key, which is your test license key.

  3. Next, you need to install API submodule by following the instructions provided in API submodule

  4. Start the server using yarn dev on localhost and create the test API keys by visiting /settings/developer/api-keys

  5. Start the API server by running yarn workspace @calcom/api dev and start testing your API locally

By default, the app server runs on port 3000 and the API server runs on port 3002

Was this page helpful?