How I find api urls in local setup

[T0useef]

I’ve successfully set up Cal.com locally on my machine and connected it with a database — everything is working perfectly.

I also have a separate website running locally, and I want to automatically create a new user in Cal.com whenever a user registers on my website.

Since I'm using the self-hosted version of Cal.com, I need to access the local API endpoints. However, I couldn’t find any API URL or documentation related to the locally installed instance.

Could you please guide me on how to access the API for my self-hosted Cal.com instance or where I can find the local API base URL and authentication details?

Thank you!

[dosubot[bot]]

Hi @T0useef! I'm Dosu and I’m helping the cal.com team.

You can access your local Cal.com API at URLs like http://localhost:3000/api/v1/ or http://localhost:3000/api/v2/, following standard Next.js conventions. For user creation, the v1 endpoint is likely http://localhost:3000/api/v1/users, which supports POST requests for creating users as defined in the codebase (source).

Authentication is handled via API keys. You can generate and manage these keys in your local Cal.com web UI at /settings/developer/api-keys (source). When making API requests, include your API key in the Authorization header as Bearer <your_api_key>. If you run into authentication issues while testing locally, make sure your localhost URL is added to the Redirect URIs in the platform settings (source).

There isn’t an OpenAPI/Swagger spec or auto-generated API docs in the repo, so you’ll need to reference the codebase for details on endpoint payloads and requirements. If you need to see exactly what fields are required for user creation, check the DTO or schema definitions in the relevant API route files.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[T0useef]

http://localhost:3000/api/v1/ this url gives me 404

[T0useef]

@dosu http://localhost:3000/api/v1/ this url gives me 404

[dosubot[bot]]

The /api/v1/ URL isn't meant to return data or a directory listing—it's just a placeholder route that normally returns a welcome message, not a 404. Actual API endpoints are more specific, like /api/v1/users for user operations. If /api/v1/ is giving you a 404, double-check that your API service is running and that you're using the correct port. In many local setups, the API runs on port 3002, so try http://localhost:3002/v1 or http://localhost:3002/v1/users instead. You can find more details about this setup in the README and codebase.

If you want to create a user, POST to /api/v1/users (or /v1/users on the API port). If all endpoints return 404, make sure your services are up and check your logs for errors.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}