// API docs

API documentation

Everything you need to integrate with Tarello features. Start at "Getting started" or jump straight to the feature you will use.

Getting started

To get started with Tarello, you need three things: an account, a project and the resources your product is going to consume.

1. Create your account

Go to console.tarello.io/start and sign up. You start on the free tier: 100 requests/month, 500 MB of storage and 1 req/s — no card needed.

2. Create a project

In the Console, click New project. Each project is an isolated environment: its own API keys, its own data and the region you choose to host in. You can have as many projects as you want in an organization.

3. Configure authentication

Authentication ships active in every project. Under Authentication, choose which fields work as identifier (email, phone, username) and enable 2FA if you want. No coding required.

4. Create a resource

Go to Project resources → New resource. Give it a name (e.g. Invoices) and add the fields with their types and rules. As soon as you save, the REST routes GET /v1/invoices, POST /v1/invoices and so on are live.

5. Generate an API key

In the project's Keys menu, click New key. Copy the generated JWT — it's only shown once.

6. First call

Test with a curl:

curl https://api.tarello.io/v1/invoices \
  -H "Authorization: Bearer YOUR_JWT_HERE"

If everything's fine, you get a paginated JSON with the list of Invoices (empty if you haven't created any yet).

Next steps