# Hive API | Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.hive.co/_mcp/server

## Docs

- [Welcome to the Hive API](https://developers.hive.co/welcome.md)
- [Quickstart](https://developers.hive.co/docs/quickstart.md): Go from credentials to your first synced order
- [Partner Portal](https://developers.hive.co/docs/partner-portal.md): Manage your OAuth credentials, redirect URIs, and portal admins
- [Authentication & Authorization](https://developers.hive.co/docs/auth.md): OAuth 2.0 Authorization Code Flow with PKCE
- [How It Works](https://developers.hive.co/docs/how-it-works.md): Asynchronous processing, idempotency, and batch validation
- [Contacts](https://developers.hive.co/docs/contacts.md): Create or update contacts and manage their custom properties
- [Orders](https://developers.hive.co/docs/orders.md): Push orders and ticket line items for your events
- [Events](https://developers.hive.co/docs/events.md): Push events, venues, and ticket tiers, and define custom event properties
- [Segments](https://developers.hive.co/docs/segments.md): List and create segments, and manage static segment membership
- [Campaign Reporting](https://developers.hive.co/docs/campaigns.md): Read email, SMS, and Meta ad campaign stats
- [Rate Limits](https://developers.hive.co/docs/rate-limits.md)
- [Errors & Status Codes](https://developers.hive.co/docs/errors-status-codes.md)
- [Glossary](https://developers.hive.co/docs/glossary.md)
- [Frequently Asked Questions](https://developers.hive.co/docs/faq.md)
- [Support & Roadmap](https://developers.hive.co/docs/support.md)
- [Changelog](https://developers.hive.co/docs/changelog.md): New features, improvements, and changes to the Hive API
- [Changelog (all entries)](https://developers.hive.co/docs/changelog/llms.txt)
- [API Reference](https://developers.hive.co/api-reference.md): Endpoint-level reference for the Hive API V2

## API Docs

- Hive API > Campaigns [List ad campaigns](https://developers.hive.co/api-reference/hive-api/campaigns/ads-retrieve.md)
- Hive API > Campaigns [Get ad campaign stats](https://developers.hive.co/api-reference/hive-api/campaigns/ads-stats-retrieve.md)
- Hive API > Campaigns [Get aggregate ad campaign stats](https://developers.hive.co/api-reference/hive-api/campaigns/ads-aggregate-stats-retrieve.md)
- Hive API > Campaigns [List email campaigns](https://developers.hive.co/api-reference/hive-api/campaigns/email-retrieve.md)
- Hive API > Campaigns [Get campaign stats](https://developers.hive.co/api-reference/hive-api/campaigns/email-stats-retrieve.md)
- Hive API > Campaigns [Get aggregate campaign stats](https://developers.hive.co/api-reference/hive-api/campaigns/email-aggregate-stats-retrieve.md)
- Hive API > Campaigns [List SMS campaigns](https://developers.hive.co/api-reference/hive-api/campaigns/sms-retrieve.md)
- Hive API > Campaigns [Get SMS campaign stats](https://developers.hive.co/api-reference/hive-api/campaigns/sms-stats-retrieve.md)
- Hive API > Campaigns [Get aggregate SMS campaign stats](https://developers.hive.co/api-reference/hive-api/campaigns/sms-aggregate-stats-retrieve.md)
- Hive API > Contacts [Create or update contacts](https://developers.hive.co/api-reference/hive-api/contacts/create.md)
- Hive API > Custom Properties [Delete custom properties from contacts](https://developers.hive.co/api-reference/hive-api/custom-properties/contacts-custom-properties-delete-create.md)
- Hive API > Events [Create or update events](https://developers.hive.co/api-reference/hive-api/events/create.md)
- Hive API > Events [Partially update an event](https://developers.hive.co/api-reference/hive-api/events/partial-update.md)
- Hive API > Custom Event Properties [List custom event properties](https://developers.hive.co/api-reference/hive-api/custom-event-properties/events-custom-properties-retrieve.md)
- Hive API > Custom Event Properties [Create custom event property](https://developers.hive.co/api-reference/hive-api/custom-event-properties/events-custom-properties-create.md)
- Hive API > Custom Event Properties [Get custom event property](https://developers.hive.co/api-reference/hive-api/custom-event-properties/events-custom-property-retrieve.md)
- Hive API > Custom Event Properties [Update custom event property](https://developers.hive.co/api-reference/hive-api/custom-event-properties/events-custom-properties-update.md)
- Hive API > Custom Event Properties [Delete custom event property](https://developers.hive.co/api-reference/hive-api/custom-event-properties/events-custom-properties-destroy.md)
- Hive API > Orders [Create or update orders](https://developers.hive.co/api-reference/hive-api/orders/create.md)
- Hive API > Segments [List segments](https://developers.hive.co/api-reference/hive-api/segments/retrieve.md)
- Hive API > Segments [Create segment](https://developers.hive.co/api-reference/hive-api/segments/create.md)
- Hive API > Segments [Delete segment](https://developers.hive.co/api-reference/hive-api/segments/destroy.md)
- Hive API > Segments [List segment users](https://developers.hive.co/api-reference/hive-api/segments/users-retrieve.md)
- Hive API > Segments [Add users to segment](https://developers.hive.co/api-reference/hive-api/segments/users-create.md)
- Hive API > Segments [Remove users from segment](https://developers.hive.co/api-reference/hive-api/segments/users-remove-create.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developers.hive.co/openapi.json)
- [OpenAPI YAML](https://developers.hive.co/openapi.yaml)