Getting Started

The Zivvy API gives you programmatic access to your business data — items, customers, orders, invoices, stock, and more. It's a REST API that returns JSON, secured with API keys.

Base URL

All API requests go to:

https://api.zivvy.dev/v1

Authentication

Every request must include your API key in the X-API-Key header:

bashcurl https://api.zivvy.dev/v1/items \
  -H "X-API-Key: zk_live_your_key_here"

You can generate API keys from Settings → API Keys in your Zivvy dashboard.

Key types

TypePrefixUse case
Livezk_live_Production integrations
Testzk_test_Development and testing

Test keys work against a sandboxed copy of your data. They can't modify production records.

Your first request

Let's fetch your items:

bashcurl https://api.zivvy.dev/v1/items?limit=5 \
  -H "X-API-Key: zk_live_your_key_here"

Response:

json{
  "data": [
    {
      "name": "IT-00001",
      "item_code": "IT-00001",
      "item_name": "Standing Desk",
      "item_group": "Furniture",
      "standard_rate": 499.00,
      "stock_uom": "Nos"
    }
  ],
  "meta": {
    "total": 42,
    "limit": 5,
    "offset": 0
  }
}

Next steps