Skip to main content

API

The Dilli Studio API is a RESTful JSON API. All requests require an API key via the X-Api-Key header. API keys are tenant-scoped and can be created and revoked in the app under Settings → API Keys. Base URL: https://app.dilli.studio/api/v1

Authentication

Send your API key in the X-Api-Key header:
GET /api/v1/contacts HTTP/1.1
Host: app.dilli.studio
X-Api-Key: YOUR_API_KEY

OpenAPI

Use the OpenAPI spec to explore and generate clients:

Example (curl)

curl -H "X-Api-Key: $API_KEY" \
  https://app.dilli.studio/api/v1/contacts?search=Jane
# Create a deal
curl -X POST -H "Content-Type: application/json" \
  -H "X-Api-Key: $API_KEY" \
  -d '{
    "name": "New opportunity",
    "deal_stage_id": "01HSTAGE0001",
    "user_id": "01HUSER0001",
    "estimated_value": 1234.56,
    "contact_ids": ["01HCONTACT01"],
    "product_ids": ["01HPROD0001"]
  }' \
  https://app.dilli.studio/api/v1/deals

Resources

  • Contacts: list, create, retrieve, update, delete
  • Companies: list, create, retrieve, update, delete
  • Products: list, create, retrieve, update, delete
  • Deals: list (filter by pipeline_id, deal_stage_id), create, retrieve, update, delete
  • Pipelines: list, create (with stages), retrieve, update (replace stages), delete
  • Tickets: list, create, retrieve, update, delete, board data (GET /tickets/board), reorder (POST /tickets/board/reorder)
  • Tasks: list, mine (GET /tasks/mine?completed=false), members (GET /tasks/members), create, update, toggle, reorder, delete