Developer Search

Search developer docs, public resources, and endpoint references.

Get Started
Welcome to the docs

Build field-service products, integrations, and migration workflows on top of Asteri.

This portal is where partner teams, internal platform builders, and migration specialists learn how to work with Asteri's keys, webhooks, future public APIs, and service-business operating model.

Current program status

Know what is live, what is preview, and what is still coming.

This portal is intentionally honest about maturity. Use the live platform surfaces now, build against the private-preview contract where available, and treat the rest as roadmap.

Updated for March 2026 preview
Live now
Scoped keys

Organization-scoped API keys, webhook endpoints, and delivery tracking are already in-product.

Shipping next
REST v1

Stable public resources for customers, appointments, estimates, invoices, and payments.

Program shape
Private preview

Partner apps, OAuth clients, and sandbox tenants will launch behind a preview program first.

What changed recently

Keep up with API and SDK movement.

Open changelog
March 23, 2026

SDK and Generated Snippets

Contract 2026-03-23.previewSDK 0.1.0
Added the generated @asteri/public-api-sdk workspace package.
Linked install/auth/usage guidance into the developer portal.
Rendered per-endpoint curl and SDK snippets inside the reference docs.
Published preview OpenAPI and SDK release assets from CI.
Start here if you want to...

Choose the task, then jump straight into the right surface.

Open developer console
Make your first authenticated request
Available now

Generate a scoped key, send explicit org context, and validate the preview auth model end to end.

Start onboarding
Consume signed webhook events
Available now

Verify signatures, inspect payloads, and model retries before you wire workers or queues.

Open webhooks
Build with the TypeScript SDK
Available now

Use the generated client, typed error handling, and example scripts instead of hand-writing fetch wrappers.

Use the SDK
Inspect endpoint contracts
Private preview

Review request bodies, response payloads, common errors, and copyable examples before integrating deeply.

Read the reference
Recommended next reads

Move through the portal in the order most teams need.

Open full reference
Getting started
Available now

Start with onboarding

Create a scoped key, confirm org context, and make the first authenticated request.

Read next
API program
Available now

Review the API program

Understand auth, scopes, rate limits, and the preview rollout before integrating deeply.

Read next
Reference index
Private preview

Check the reference index

Inspect request and error contracts for customers, appointments, estimates, and invoices.

Read next
TypeScript SDK
Available now

Use the SDK guide

Skip hand-written fetch code and adopt the generated TypeScript client plus error handling.

Read next
Coverage matrix

See which resources are live, preview, or roadmap.

Inspect contracts
ResourceAPIDocs
API keysAvailable nowOpen docs
Webhook eventsAvailable nowOpen docs
CustomersPrivate previewOpen docs
AppointmentsPrivate previewOpen docs
EstimatesPrivate previewOpen docs
InvoicesPrivate previewOpen docs
PaymentsPrivate previewOpen docs
ServicesPrivate previewOpen docs
FilesPrivate previewOpen docs
Sandbox tenantsPlanned v1Open docs
Partner OAuth appsPlanned v1Open docs
User guides

Start with the real surfaces that already exist.

Private preview 2026
Developer onboarding

Developer Onboarding

Use the quickstart to create a workspace, generate scoped keys, configure signed webhooks, and choose the right integration lane.

Read the guide
API management

API Program

Review how Asteri will separate stable public resources from internal tRPC procedure shapes and roll out REST, OAuth, and SDKs in layers.

Read the docs
Event delivery

Webhook Reference

Explore signed delivery, retries, event categories, payload shape, and the replay-oriented operating model built into Asteri.

View details
Standards

Design the public platform around durable contracts.

Available now
Scoped API keys

Least-privilege scopes, expiration controls, and rate-limit settings already exist in the security center.

Available now
Signed webhooks

HMAC signatures, retries, delivery history, reliability views, and secret rotation are already supported.

Available now
Outbound REST automations

Teams can call external APIs from Asteri workflows without custom middleware.

Available now
Integration catalog

Payments, accounting, communications, storage, databases, and social connectors are already part of the platform surface.

Contract blueprint

The first public contract should start with the revenue and operations backbone.

customersappointmentsestimatesinvoicespaymentsteam membersservicesfileswebhook endpoints

What makes this portal better

Field-service native contracts

Asteri is not another generic CRM API. The portal is organized around revenue, dispatch, estimate, invoice, and compliance workflows.

Operational visibility built in

Developers need request logs, webhook replay, secret rotation, and rate-limit insight in the same surface as the docs.

Migration lanes, not just references

Teams leaving incumbents need compatibility guidance, workflow recipes, and onboarding paths that shorten the switch.

API reference

Reference cards with live program state.

Open API program

Customers

Private preview

Customer identity, contact points, tags, and activity history for field-service operations.

View reference

Appointments

Private preview

Scheduling, assignment, completion lifecycle, and downstream operational triggers.

View reference

Estimates

Private preview

Quote creation, approval flows, acceptance events, and revenue transition states.

View reference

Invoices

Private preview

Billing state, payment collection hooks, and accounting-system handoff.

View reference

Payments

Private preview

Collected payments, invoice linkage, payment methods, and collection-state visibility.

View reference

Services

Private preview

Service catalog visibility for pricing, duration, and booking-facing configuration.

View reference

Files

Private preview

Uploaded file records, MIME metadata, processing status, and storage-bucket context.

View reference

Webhook Events

Available now

Signed event delivery with retries, delivery history, secret rotation, and replay-oriented operations.

View reference

API Keys

Available now

Scoped keys, expirations, and rate limits already live inside the Asteri security center.

View reference

TypeScript SDK

Available now

Generated fetch-based client package aligned with the public OpenAPI contract.

View reference

Launch tracks

Operational automations

Connect Asteri to CRMs, data stores, and finance systems with signed events and outbound REST actions.

Embedded service workflows

Build customer, estimate, invoice, and payment flows on top of Asteri instead of stitching together generic back office tools.

Migration accelerators

Give teams leaving Jobber and adjacent platforms a faster route into Asteri with recipes, import guides, and compatibility notes.

Roadmap
1. Public REST API v1

Stable external DTOs and versioned routes instead of exposing internal tRPC shapes.

2. Sandbox tenants and seeded data

Every developer should be able to test a realistic service company before touching production.

3. Partner app console

OAuth clients, scopes, review workflow, usage analytics, and changelog subscriptions in one place.

Frequently asked questions

Questions teams ask before they build.

Can I use the developer portal before the public REST API ships?

Yes. The current program starts with scoped API keys, signed webhooks, outbound REST automations, and the integrations/security surfaces already in Asteri.

Will third-party partners get OAuth?

Yes, but after the public REST contract and app review workflow are stable. Server-to-server access comes first.

Is this only for external partners?

No. The portal is also for internal platform teams, operators building automations, and migration specialists moving teams off incumbent tools.