Skip to Content
DocsAPIAuthentication

Authentication

Generate a short-lived JWT that authorizes all subsequent API requests on behalf of your organization.

Endpoint

  • POST: /authenticate

Request

FieldLocationRequiredDescription
access_keyBody (JSON)24-character access key which you can request from support@heypeers.com.
curl -X POST "https://heypeers.com/api/v2/authenticate" \ -H "Content-Type: application/json" \ -d '{"access_key": "YOUR_ACCESS_KEY"}'

Responses

StatusBody
200 OK{ "token": "YOUR_JWT_TOKEN" }
401 Unauthorized{ "error": "Invalid Access Key" }

The JWT expires after 24 hours. Refresh it daily (or sooner) and cache it in your integration layer.***

Last updated on