Skip to main content

Smarty.tel API

Welcome to the Smarty.tel REST API reference. This API lets external applications connect to your Smarty.tel instance to read and write records, call whitelisted server-side methods, manage files, and receive real-time webhook notifications.

The API follows a resource-oriented REST design: every Doctype (a record type such as Customer, Ticket, Contact, or Lead) is exposed at a predictable URL, and the same verbs (GET, POST, PUT, DELETE) work the same way across every resource.

Base URL​

https://app.smarty.tel/api

All endpoints in this reference are relative to this base URL.

What you can do with the API​

  • Resource API — list, filter, create, update, and delete documents for any doctype exposed on your site. See Resource (Document) API.
  • Method API — call whitelisted server-side functions (@frappe.whitelist() style endpoints) for actions that don't map cleanly to CRUD. See Method API.
  • Authentication — authenticate requests with API key/secret pairs, or session/cookie auth for browser-based integrations. See Authentication.
  • Files — upload and download attachments linked to any document. See File Uploads.
  • Webhooks — subscribe to document events (on_update, after_insert, on_submit, ...) and receive signed HTTP callbacks in real time. See Webhooks.
  • Errors & rate limits — understand the error envelope and how request throttling works. See Errors & Rate Limits.

Quick example​

Fetch the first 20 open tickets, sorted by creation date:

curl -X GET \
  "https://app.smarty.tel/api/resource/Ticket?filters=[[\"status\",\"=\",\"Open\"]]&limit_page_length=20&order_by=creation desc" \
  -H "Authorization: token <api_key>:<api_secret>"
{
  "data": [
    {
      "name": "TICK-2026-00042",
      "subject": "Cannot activate SIM card",
      "status": "Open",
      "creation": "2026-08-18 09:12:03"
    }
  ]
}

Continue to Authentication to get your API credentials.