API Reference Overview

The EnterestOS API is intentionally small.

⏱ 2 min

Problem: You need to know what the API can do before you start building — and how its Response terminology relates to the Inbox terminology in the app.

Solution: The EnterestOS API has three methods. That is the entire surface.

Terminology

In the EnterestOS app you work with Submissions. In the SDK and API that same event is called a Response. A successful website submission becomes a Response through trackResponse().

typescript
createEnterestOS(config)  // create a client bound to a project
trackResponse(input)      // send a response to EnterestOS
testConnection()          // verify your project key works

The API is intentionally minimal. It tracks responses. It does not send emails, manage contacts, build forms, or automate workflows. Everything else is handled in the Inbox or by tools you already use.

Result: You now know the complete API surface. Three methods, one purpose.

Common Questions

What can I do with the EnterestOS API?

Create a client (createEnterestOS), track responses (trackResponse), and verify connectivity (testConnection). That is the full surface. Submission lifecycle management — moving from Reply to Waiting to Done — happens in the Inbox.

Next

createEnterestOS() →