Skip to documentation
Asteri/Developers

Developer Search

Search developer docs, public resources, and endpoint references.

Get started

  • Overview
  • Quickstart

Build

  • API basics
  • API reference
  • TypeScript SDK
  • Webhooks

Manage

  • Integration setup
  • Changelog

REST API v1

OpenAPI specificationContact Asteri

Developer documentation

Build with Asteri

Connect your tools to your CRM. Read customer data, keep jobs in sync, and automate the work between systems.

Start buildingBrowse API reference

From API key to first request

  1. 1

    Create an API key

    Open Security → Developer in your CRM. Start with the read:customers permission.

    Open developer settings
  2. 2

    Make your first request

    Set your app address and API key, then run the customers example.

    Follow the quickstart
  3. 3

    Keep your integration up to date

    Use webhooks to receive changes without repeatedly checking for them.

    Set up webhooks
GET /api/public/v1/customers
curl "$ASTERI_BASE_URL/api/public/v1/customers?limit=5" \
  -H "Authorization: Bearer $ASTERI_API_KEY"

Set ASTERI_BASE_URL to your Asteri app address. Use a key with read:customers and keep it on your server.

One key, one company

Your key selects the company it can access. Paid plans include reads and exports; Premium and above also include writes.

Work with your CRM data

Customers and leadsConnect contact details and incoming enquiries.
Jobs and appointmentsRead schedules, assignments, and job progress.
Estimates and invoicesConnect quoting, billing, and payment workflows.
Photos and checklistsWork with field photos, job notes, and checklists.

Build a reliable integration

Use the TypeScript SDKMake typed requests with the generated client and handle API errors.Receive CRM updatesVerify signed events and handle retries safely.Manage your integrationFind API keys, request usage, and webhook settings in your CRM.

Latest update · October 24, 2026

Task due times and note authors

View changelog
Asteri developer documentation · View changelog