beya
Demo Login Get started
Getting Started

API Overview

The Beya API lets you programmatically access your company's contacts and inbox data. Build integrations, sync with your CRM, or create custom workflows.

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

Quick start

  1. 1
    Generate an API key
    Go to Settings → API Keys in your Beya dashboard and create a new key. Select the scopes you need.
  2. 2
    Make your first request 
    curl https://api.usebeya.com/v1/contacts \
  -H "x-api-key: bk_live_your_key_here"
  3. 3
    Explore the API
    Use the sidebar to explore available endpoints for Contacts and Inbox.

Available APIs

📇

Contacts

Create, read, update, and search contacts across your company.
  • List contacts
  • Create / update contacts
  • Get contact by ID
  • Search by email or phone
📬

Inbox

Access email and messaging threads across your team.
  • List threads and flows
  • Fetch messages in a thread
  • Filter by contact