> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.hive.co/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.hive.co/_mcp/server.

# Welcome to the Hive API

## Connect your platform with *Hive*

Sync contacts, orders, and events from your platform with one API.

> **Info**
>
> The Hive API V2 is in **beta**. Questions or feedback? Email [api@hive.co](mailto:api@hive.co).

## Overview

The Hive API lets your platform **push** contact, order, and event data directly into Hive. Instead of Hive pulling data from your systems, you send it to us, so you control when and what data is synced. You can also read back segments, custom event properties, and campaign reporting.

* **Push-based**: you send data to Hive when it's ready.
* **Asynchronous**: data pushes are acknowledged immediately with `202 Accepted`, then processed in the background.
* **Eventually consistent**: data typically appears within minutes (up to 1 hour during beta).
* **Brand-scoped**: every access token is scoped to a single brand, so you never pass a brand identifier in requests.

## Base URL

```
https://api.hive.co/v2
```

## Get started

#### Get onboarded

Contact your Hive representative to become an API partner. You'll receive a welcome email once your Partner Portal access is provisioned.

#### Sign in to the Partner Portal

Use the [Partner Portal](/docs/partner-portal) to view your `client_id`, rotate your client
secret, and register your OAuth redirect URIs.

#### Implement OAuth

Build the OAuth 2.0 Authorization Code Flow with PKCE. See [Authentication & Authorization](/docs/auth).

#### Send your first request

Follow the [Quickstart](/docs/quickstart) to push your first event and order.

## Explore the API

#### [Contacts](/docs/contacts)

Create or update contacts and manage their custom properties.

#### [Orders](/docs/orders)

Push orders and ticket line items for your events.

#### [Events](/docs/events)

Push events, venues, and ticket tiers, and define custom event properties.

#### [Segments](/docs/segments)

List and create segments, and add or remove users from static segments.

#### [Campaign reporting](/docs/campaigns)

Read email, SMS, and Meta ad campaign stats.

#### [API Reference](/api-reference)

Endpoint-level request and response schemas.