Skip to main content
Version: 1.0.0

WhatPulse Professional API

The WhatPulse Professional API allows you to programmatically access your organization's productivity and activity data. Use this API to integrate WhatPulse data with your own applications, dashboards, and reporting tools.

Authentication

All API requests require authentication using a Bearer token. You can create API keys in your organization settings.

Include the token in the Authorization header:

Authorization: Bearer wp_your_api_key_here

Rate Limiting

API requests are rate limited to protect service quality:

  • General endpoints: 1000 requests per hour
  • Time series endpoints: 100 requests per hour

Rate limit headers are included in all responses:

  • X-RateLimit-Limit: Maximum requests allowed in the current window
  • X-RateLimit-Remaining: Requests remaining in the current window
  • X-RateLimit-Reset: Unix timestamp when the current window resets

Pagination

List endpoints support pagination with the following query parameters:

  • page: Page number (default: 1)
  • per_page: Items per page (default: 25, max: 100)

Response metadata includes pagination info in the meta object.

Authentication

API key obtained from organization settings

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer