# Hiver API

**Canonical:** https://apis.io/apis/hiver/hiver-api/  
**Provider:** Hiver — https://apis.io/providers/hiver/  
**Base URL:** https://api2.hiverhq.com/v1  
**Documentation:** https://developer.hiverhq.com/hiver-api

Hiver API is published by [Hiver](https://apis.io/providers/hiver/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Customer Service, Shared Inbox, Conversations, Tags, and Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

The Hiver REST API (v1) exposes Shared Inboxes and their conversations, users, tags and internal notes. Twelve operations across two resources let an integration list and read inboxes, enumerate and search inbox users and tags, create tags, list and read conversations, update a conversation's status/assignee/tags, create a shared draft and post an internal note. Authentication is a single admin-scoped API key sent as an HTTP Bearer token; responses are JSON wrapped in a `data` envelope with opaque-cursor pagination.

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/openapi/hiver-api-openapi.json
- **Documentation** — https://developer.hiverhq.com/hiver-api
- **APIReference** — https://developer.hiverhq.com/api-runner/hiverhq/hiver-api
- **GettingStarted** — https://help.hiverhq.com/hiver-api/hiver-api
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/authentication/hiver-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/conventions/hiver-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/errors/hiver-problem-types.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/rate-limits/hiver-rate-limits.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/data-model/hiver-data-model.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/overlays/hiver-api-overlay.yaml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/lifecycle/hiver-lifecycle.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/hiver/refs/heads/main/apis.yml

## Tags

Customer Service, Shared Inbox, Conversations, Tags, Notes

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hiver/hiver-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hiver/.
