Getting started / Quick start

Quick Start

Get started with the API in just a few steps:

Your first request

List the editions you belong to — every other resource hangs off an edition.

cURL

curl "https://api.app.vanihq.com/vani/api/v1/editions" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"

Response200 · application/json

{
  "data": {
    "editions_info": [
      {
        "created_time": "Sun, 09 Apr 2023, 08:43:02",
        "last_modified_time": "Sun, 09 Apr 2023, 08:43:02",
        "edition_id": "75918186",
        "edition_type_name": "ORG",
        "state": "ACTIVE",
        "edition_name": "OrgEdition",
        "edition_owner_id": "69828190",
        "is_default": "true",
        "uri": "/vani/api/v1/editions/75918186"
      }
    ]
  },
  "message": "Editions fetched successfully",
  "request_uri": "/vani/api/v1/editions",
  "status": "success"
}

Where to go next

Choose a resource category from the sidebar
Browse available endpoints and their documentation
Use the interactive status code picker to explore responses
Copy code examples in your preferred programming language

Authentication →

OAuth 2.0 setup, scopes and the API-key alternative.

Browse the API →

All resource groups, with per-operation scopes and rate limits.