Skip to content
Adva Docs

Getting Started

Overview

Section titled “Overview”

The Adva API is a RESTful JSON API following the OpenAPI 3.1 specification. All endpoints accept and return application/json.

The API is organized into four domains under a versioned base path:

DomainBase PathResources
Core/api/v1/corecustomers, contacts, team members, products, deals
Sales/api/v1/salesproposals, promotions, appointments
Operations/api/v1/opsjobs, equipment, crews, maintenance logs
Finance/api/v1/financeinvoices, commission plans

Base URL

Section titled “Base URL”
https://api.getadva.ai/api/v1

All endpoints are prefixed with /api/v1. The version is included in the path to support future API versions.

Content Type

Section titled “Content Type”

All requests with a body must include:

Content-Type: application/json

All responses are returned as JSON.

Authentication

Section titled “Authentication”

Every request requires a Bearer token. See Authentication for details on obtaining and using tokens.

Your First Request

Section titled “Your First Request”

1. List Customers

Section titled “1. List Customers”
Terminal window
curl -X GET https://api.getadva.ai/api/v1/core/customers \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response:

{
  "customers": [
    {
      "contact_id": "550e8400-e29b-41d4-a716-446655440000",
      "display_name": "John Smith",
      "lifecycle_status": "active"
    }
  ],
  "total": 142,
  "limit": 50,
  "offset": 0
}

2. Get a Single Resource

Section titled “2. Get a Single Resource”
Terminal window
curl -X GET https://api.getadva.ai/api/v1/core/customers/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

3. Create a Resource

Section titled “3. Create a Resource”
Terminal window
curl -X POST https://api.getadva.ai/api/v1/core/products \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium Lawn Treatment",
    "category": "turf",
    "unit_price": 299.99
  }'

A successful creation returns 201 Created with the new resource in the response body.

Interactive API Reference

Section titled “Interactive API Reference”

Browse all endpoints interactively with the built-in API reference:

  • API Endpoints — Full interactive reference with try-it requests

The raw OpenAPI 3.1 spec is also available at /api/openapi.json.

Next Steps

Section titled “Next Steps”