Skip to main content

API Introduction

Userdocks helps you launch web applications faster by providing authentication, authorization, user lifecycle management, billing, and growth tooling behind a single REST API.

This API section is the technical guide for integrating Userdocks into your frontend and backend services. It explains how to:

  • authenticate users in client-facing flows
  • authorize access to protected resources
  • manage users and tenants from your own backend
  • run subscription and one-time payment flows
  • connect webhook and billing operations for Stripe-based integrations

If you are building with Userdocks for the first time, start with public endpoints for user onboarding and sign-in, then move to private bearer or API key endpoints for server-side management operations.

Endpoint Groups

Endpoints are grouped by exposure and auth model so you can quickly find the correct contract for each context:

  • external/public: no auth middleware, used for public app flows
  • external/private-bearer: JWT-protected endpoints for authorized actors
  • external/private-api-key: app-to-app operations authenticated with API key headers
  • internal/public: unauthenticated internal lookup endpoints
  • internal/private-bearer: dashboard/operator endpoints protected by bearer auth

Use this reference together with your app architecture: clients should call only endpoints intended for public or user-authorized flows, while sensitive management actions should stay on trusted server paths.

Next Step

Continue to Endpoint Reference for base paths, auth headers, error envelope details, and full route coverage.