HeyPeers API Documentation for Organizations

Overview

Welcome to the HeyPeers API docs for organizations. This landing page provides the global context—access keys, environments, and support resources—while the sidebar links to endpoint-specific references (Authentication, Invites, One-Time Login, Meeting Attendance, Surveys, etc.).

Obtaining the Access Key

Each organization is assigned a unique access key. Organization owners can generate and rotate this key from the Manage Organization page. 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 (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.