Skip to main content

Getting Started

This guide walks you through making your first API call to the Tidely Public API.

1. Obtain an API Key​

Log in to the Tidely application and navigate to Settings → API Keys.
Staging environment direct link: https://app.sam.tidely.com/settings/openapi

To create a new API key

  • click the + icon
  • name your API key based on the intended usage
  • select the company the key should be scoped to
  • select the permissions to limit the API key's range of operations to what is needed for your use case

Make sure to store the created key securely.

2. Verify Your Authentication​

Test your API key with the authentication endpoint:

curl -X GET https://api.tidely.com/public/v2/authentication/verify-auth \
  -H "X-Authorization: YOUR_API_KEY"

A successful response:

{
  "success": true,
  "message": "Authentication successful",
  "name": "Your API key name"
}

3. List Your Bank Accounts​

Retrieve your connected bank accounts:

curl -X GET https://api.tidely.com/public/v2/bank-accounts \
  -H "X-Authorization: YOUR_API_KEY"

4. Create a Financial Plan​

Create a monthly financial plan for a category:

curl -X POST https://api.tidely.com/public/v2/plans \
  -H "X-Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryName": "E-Commerce Revenue",
    "amount": 50000.00,
    "period": "MONTHLY",
    "date": "2025-01-01",
    "type": "ONE_TIME",
    "name": "January Revenue Target"
  }'

5. Import an Invoice​

Sync an invoice from your ERP system:

curl -X POST https://api.tidely.com/public/v2/invoices \
  -H "X-Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invoiceId": "ERP-2025-001",
    "invoiceNumber": "2025-001",
    "contactName": "ACME Corp",
    "invoiceType": "SALES_INVOICE",
    "totalGrossAmount": 11900.00,
    "invoiceDate": "2025-01-15",
    "dueDate": "2025-02-15",
    "currency": "EUR"
  }'

Base URLs​

EnvironmentURL
Productionhttps://api.tidely.com/public/v2
Staginghttps://api.sam.tidely.com/public/v2

Next Steps​