HeyPeers API Documentation for Organizations

Overview

Welcome to the HeyPeers API for organizations—a REST API that connects HeyPeers to your own tools and workflows. With it you can manage your members, pull meeting and attendance data, retrieve survey responses, and react to events in real time through webhooks. Every request is authenticated with a short-lived token tied to your organization’s access key, and all responses are JSON. To get started, request your access key as described in the next section, then use the sidebar for the full, endpoint-by-endpoint reference.

Obtaining the Access Key

Each organization is assigned a unique access key. Access keys are issued by the HeyPeers team—email support@heypeers.com with your organization name to request one (or to rotate an existing key). Guard it like a password—anyone with the key can mint API tokens.

Base URL

All URLs referenced in the documentation share the following base:

https://heypeers.com/api/v2

Use the staging host for testing (ask support for the latest URL and credentials).

How to Use the API

1. Generate a short-lived JWT via the Authentication endpoint.
2. Call the feature-specific endpoints (Webhook, Invites, OTL links, reporting APIs) using the Authorization: Bearer <token> header.
3. Refresh the token daily—the JWT expires after 24 hours to reduce risk.

Each endpoint guide (linked on the left) includes request/response samples, required headers, and validation errors so you can plug the calls into Postman, Insomnia, or your integration codebase.

Support

If you encounter any issues or have questions about the API, email support@heypeers.com with your organization name, request details, and any correlation IDs returned in error responses.