Quickstart

The HyperRep API is a ReSTful API, so it can integrate cleanly with any programming language or framework that supports HTTP requests. Make your first HyperRep API requests by authenticating with an API key and using the IDs returned by the API.

Authenticate

Obtain your API key by emailing [email protected]. Every request to the HyperRep API should include your API key in the X-API-KEY header.

Keep your API key private and secure. Leaking your API key can lead to unauthorized access to your HyperRep data. If you believe your API key has been compromised, contact support immediately to have it revoked and replaced: [email protected].

Request headers

curl https://api.hyperrep.ai/api/v2/organizations \
  -H "X-API-KEY: your-api-key"

Example response

{
  "data": [
    {
      "organization_id": "gAAAAABexampleOrganizationIdReturnedByApi7mN4qP2xLs9dV5kTr8cY1hJ6uW3",
      "name": "Acme Roofing"
    }
  ]
}

List organizations

Start by listing the organizations available to your API key. The response will give you the organization_id value you will use in the rest of the API.

List organizations

curl https://api.hyperrep.ai/api/v2/organizations \
  -H "X-API-KEY: your-api-key"

Example response

{
  "data": [
    {
      "organization_id": "gAAAAABexampleOrganizationIdReturnedByApi7mN4qP2xLs9dV5kTr8cY1hJ6uW3",
      "name": "Acme Roofing"
    }
  ]
}

Use returned IDs

Once you have an organization_id, you can use it to read related resources such as conversations, contacts, sales, companies, agents, and analytics.

This pattern of obtaining an ID from one endpoint and using it to access related endpoints is common across the API.

For example:

Get an organization_id from GET /api/v2/organizations
- Later you can access messages, conversations, contacts, or analytics from that organization using the same organization_id
Get a conversation_id from GET /api/v2/organizations/{organization_id}/conversations
- Later you can access messages from that conversation using the same conversation_id
- Get GET /api/v2/organizations/{organization_id}/conversations/{conversation_id}/messages

Using this pattern you can see insights about different key metrics in your HyperRep account.

List conversations for one organization

curl -G https://api.hyperrep.ai/api/v2/organizations/gAAAAABexampleOrganizationIdReturnedByApi7mN4qP2xLs9dV5kTr8cY1hJ6uW3/conversations \
  -H "X-API-KEY: your-api-key" \
  --data-urlencode "limit=10"

Example response

{
  "data": [
    {
      "conversation_id": "gAAAAABexampleConversationIdReturnedByApi8kP3xLs7dV2mTr5cN9hY1uJ4",
      "start_at": "2026-04-29T14:00:00Z",
      "last_activity_at": "2026-04-29T16:00:00Z",
      "folder": "inbox",
      "is_read": false,
      "contact_id": "gAAAAABexampleContactIdReturnedByApi4pQ8xLm2sV7kRt1cN5hY9uJ3dF6"
    }
  ],
  "pagination": {
    "limit": 10,
    "cursor": null,
    "next_cursor": null,
    "has_more": false
  }
}

Next steps

Continue with the pages below once your first request is working: