HyperRep API

Use the HyperRep ReST API to read organizations, contacts, companies, agents, conversations, messages, analytics, and sales data from your HyperRep account, and to create outbound message drafts and conversation response drafts.

Quickstart View API References

Getting started

Build on the same customer and conversation data your team uses in HyperRep. The quickstart shows how to authenticate, find your organizations, and make your first request. From there, use the guides and reference to connect the resources your integration needs.

See request patterns

Guides

Quickstart

Make your first request, list organizations, and use returned IDs in follow-up calls.

Making requests

See the standard cURL and Python patterns for headers, path parameters, and filters.

Route directory

Expand each route and inspect the JSON response shape derived from the live API schema.

Authentication

Authenticate every request with your HyperRep API key using the X-API-KEY header.

Errors

Understand common validation, authorization, and not-found responses.

Organizations

Start here to list the organizations available to your API key and get the IDs you need for follow-up requests.

Analytics

Query conversation and sales analytics with a required date range for each request.

Contacts

Read records for individual customers and their associated conversations.

Companies

Browse company records for companies that your organization has worked with.

Sales

List organization sales, fetch one sale by ID, and filter sales by agent ownership.

Conversations

List conversation summaries for an organization and fetch a single conversation by ID.

Messages

Read message history for a conversation and retrieve individual messages by ID.

Message Drafts

Create outbound message drafts, optionally queue them for async send, and attach notification context.

Response Drafts

Create or update conversation response drafts for follow-up replies and optionally queue them for async send.

Agents

Find the agents associated with an organization and retrieve their individual details.

Audit Logs

Review normalized audit changes for sales, conversations, message drafts, and response drafts.