Skip to main content
The v2 API is the current Usertour REST API. It is project-scoped, authenticated with personal API tokens, and generated from a single source of truth (so this reference always matches the server).
Beta. The v2 API (and its MCP endpoint) is stable enough to build on, but the surface may still change while it’s in Beta — breaking changes will be called out in the changelog. Feedback is welcome.
Looking for the older API? See the legacy v1 reference (still supported for existing integrations). v2 is recommended for everything new — it adds content authoring (read and write), publishing, and an MCP endpoint for AI agents.

​
Base URL

All requests use HTTPS. Every v2 path is rooted at a project:
Business data (users, companies, sessions) is additionally scoped to an environment:

​
Authentication

Send a personal API token as a Bearer header:
Tokens carry scopes and are bound to one or more projects. See Authentication.

​
Conventions

  • Pagination — list endpoints return { results, next, previous } with cursor paging. See Pagination.
  • Ordering — orderBy (e.g. -createdAt). See Ordering.
  • Expanding — expand inlines related objects (e.g. ?expand=steps, ?expand=editedVersion). See Expanding objects.
  • Attributes — custom fields on users/companies/events. See Attributes.
  • Errors — a stable { error: { code, message } } envelope. See Errors.

​
What’s different from v1