Skip to content
TellMeHow Developers
en

API documentation

Run your audits through the API

A REST API and an MCP server per workspace: set up engagements, follow interviews, and publish the deliverable from your own tools or from Claude.

Browse the reference Connect Claude
REST operations
262
modules
12
MCP tools
184

Base URL

Each workspace has its own API, on its own subdomain. Replace {your-workspace} with your workspace address (the one you open in your browser).

URL 
https://{your-workspace}.tellmehow.io/api/v1

It is the same API as the web app: same rules, same roles, same checks. Nothing is reachable through the API that is not reachable in the app for the same member.

Get started in three steps

  1. Create an API key

    In your workspace, menu “API & integrations”, tab “API keys”: name the key, choose its scope (read only, or read and write) and its lifetime. Copy it right away: it will not be shown again.

  2. Call the API

    Send the key in the Authorization header. For instance, to list the five most recent engagements:

    Terminal 
    curl "https://{your-workspace}.tellmehow.io/api/v1/engagements?limit=5" \
  -H "Authorization: Bearer pat_…"

  3. Explore the reference

    Every operation is described in the reference, module by module, with a ready-to-copy example. Download the OpenAPI contract to generate a client in your language.

Versioning

The API version is part of the path: /api/v1. Within a version, the API evolves without breaking anything.

  • Additions without notice: new operations, new optional fields, new values in a list. Your code should ignore what it does not know.
  • Nothing is removed or renamed in a published version: a breaking change opens a new version (/api/v2), announced in advance.
  • Error codes are stable: an existing code keeps its meaning.

Going further