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

Quickstart

Make your first request

Create an API key and read the customers in your Asteri company.

On this page
Create a keySend a requestCheck the responseBuild your integration

Before you start

Use an existing Asteri company with a paid plan. Every paid plan can read and export data; writes require Premium or above. If you need a company first, book a demo and the Asteri team will set up your account.

1. Create an API key

Open Security & access → Developer in the CRM. Select Create key, give it a name you will recognize, and select read:customers for this example.

Set an expiry and request limits for the integration. Copy the key when it appears: the full value is shown once.

Create an API key

Keep your key on your server

Store it as a secret in your server environment. Never include it in browser code, a mobile app, a public repository, or a screenshot.

2. Send a request

Replace ast_live_your_key with the key you just created. This example uses a local Asteri server; replace http://localhost:3000 with your deployed Asteri app origin when connecting to a deployed company.

List customers
curl --request GET \
  "http://localhost:3000/api/public/v1/customers?limit=25" \
  --header "Authorization: Bearer ast_live_your_key"

The bearer key selects the company automatically. You do not need to send an organization header.

3. Check the response

A successful request returns 200, a data array, and pagination details. An empty array means the request worked and no customers matched.

401
Check that the full key is present, active, and not expired.
403
Check the company plan, key scopes, and any IP allowlist. This request needs read:customers.
429
Wait for the time in Retry-After before sending another request.

4. Build your integration

Read the customer endpointsFind fields, filters, required scopes, and response examples.Use the TypeScript SDKCall typed client methods and handle API errors in your code.Receive webhook eventsKeep your system up to date when records change in Asteri.Learn the API basicsUnderstand authentication, pagination, retries, and rate limits.
Asteri developer documentation · View changelog