Tines 3B ships a full REST API, and the reference for it lives right inside your Tines 3B tenant. This guide shows you where to find the interactive docs, how to read the raw specification, and how to get an API key so you can start making calls. If you don't have a Tines 3B tenant yet, there's a section at the end for you too.
What the API docs include
Tines 3B publishes its API reference in two forms, both served from your own Tines 3B tenant:
Interactive documentation. A browsable Swagger UI at
/api/v1/docs, where every endpoint is listed with its parameters, request bodies, and response shapes.The raw OpenAPI specification. A machine-readable OpenAPI 3.1 document at
/api/v1/openapi.json, which you can feed into code generators, Postman, or your own tooling.
The interactive page is built directly from that specification, so the two always describe the same API.
How to open the docs
The documentation pages are available from the same tenant you use to sign in to Tines 3B. To open them, either select the API docs link for the menu dropdown from your profile avatar:
Or, go directly to:
https://<your-3B-tenant>/api/v1/docs
Note: Replace <your-3B-tenant> with the address of your Tines 3B tenant, the same one you see in your browser when you're signed in.
You don't need to sign in or supply an API key just to read the docs. The documentation and the specification are viewable on their own, so you can explore the endpoints before you set up any credentials.
To grab the raw specification instead, open:
https://<your-3B-tenant>/api/v1/openapi.json
Get an API key so you can make calls
Reading the docs is open to everyone, but every API endpoint itself requires authentication. You authenticate with an API key passed as a Bearer token in the Authorization header. Tines 3B API keys start with the prefix 3b_sk_.
To create one:
Open Settings, then go to Members.
Select your own member entry.
Switch to the Access tab.
Under API keys, select the plus button and give the key a name.
Copy the key when it's shown and store it somewhere safe.
A few things worth knowing about these keys:
They act as you. A key carries your own access, no more and no less.
They expire after 24 hours. Treat each key as short lived, and generate a fresh one when it lapses.
They're secrets. Handle them like passwords, and revoke any key you no longer need from the same API keys section.
Make your first request
Once you have a key, you can call any documented endpoint. Pass the key as a Bearer token. For example, to list the spaces you can access:
curl https://<your-3B-tenant>/api/v1/spaces \ -H "Authorization: Bearer 3b_sk_your_key_here"
In the interactive docs, you can also paste your key into the authorization field and try endpoints directly from the page.
If you don't have a tenant yet
The API docs live inside a running Tines 3B tenant, so to reach them you first need access to one. The quickest way to get one is to sign up for our free Explore plan.
Once your tenant is up and you can sign in, come back to the steps above. Opening /api/v1/docs on your tenant and creating an API key are all you need to start building.
Read about all Tines 3B plans and packaging here.