API overview

The Bevits public API allows integrations and AI agents to query an organization’s data. The first version is read-only and uses an API key linked to the organization.

Base URL: https://api.bevits.com/v1

Make your first request

Create an API key

Go to Settings → Advanced → API Keys, create a key with read access, and copy the secret. It is displayed only once.

Store the key in an environment variable

export BEVITS_API_KEY="bvt_live_..."

Query the connection identity

curl --request GET \
  --url https://api.bevits.com/v1/me \
  --header "Authorization: Bearer $BEVITS_API_KEY"

{
  "object": "identity",
  "organization": {
    "id": "org_ckxyz123",
    "name": "My store"
  },
  "api_key": {
    "id": "bak_ckkey123",
    "name": "Integration",
    "scopes": ["read"]
  },
  "livemode": true
}

Available resources

Customers

Search customers, contact data, tags, attributes, metrics, and purchases.

Segments

List segments and query their customers.

Automations

Query flows and their execution summaries.

Campaigns

Query email campaigns and aggregate metrics.

Customers and purchases

Resource	Main endpoints
Customers	`GET /customers`, `GET /customers/{customer_id}`
Customer purchases	`GET /customers/{customer_id}/purchases`
Segments	`GET /segments`, `GET /segments/{segment_id}/customers`
Purchases	`GET /purchases`, `GET /purchases/{purchase_id}`
Tags and attributes	`GET /tags`, `GET /attributes`

Marketing and automation

Resource	Main endpoints
Flows	`GET /flows`, `GET /flows/{flow_id}`
Email campaigns	`GET /email-campaigns`, `GET /email-campaigns/{email_campaign_id}`

The API key automatically determines the organization. Do not send an organization ID in this version’s routes.

Next steps

Authentication

Create, store, and revoke credentials securely.

Pagination and errors

Understand cursors, IDs, limits, and error responses.

AI agents

Use the API with Leme, Claude Code, Codex, and other agents.

Getting started

Fundamentals

Reference

Make your first request

Available resources

Customers

Segments

Automations

Campaigns

Customers and purchases

Marketing and automation

Next steps

Authentication

Pagination and errors

AI agents

​Make your first request

​Available resources

Customers

Segments

Automations

Campaigns

​Customers and purchases

​Marketing and automation

​Next steps

Authentication

Pagination and errors

AI agents

Make your first request

Available resources

Customers and purchases

Marketing and automation

Next steps