Partner REST API v1

Connect your app to real-world health data.

Integrate real-time Kulawise health metrics directly into your application with your user's consent using their registered email or username and an API key. Fast lookups, zero down-times.

1

Request Partner Access

To keep partner onboarding frictionless and eliminate dashboard bloat, we provision your API keys directly. Send a quick email to our engineering team:

Please include in your message:

  • Your application name
  • Website
  • Information on what you do and how Kulawise would be used by your users
2

Authenticate Your Requests

Upon approval, you will receive a production API key (e.g. kula_...). Pass this key in the request headers on every call:

// Recommended Header:
X-Partner-Key: kula_YOUR_SECRET_KEY
// Or via Authorization Bearer:
Authorization: Bearer kula_YOUR_SECRET_KEY
3

Fetch User Health Metrics

With your user's consent, query their aggregated daily health data by supplying either their Kulawise account email or username (especially convenient if the user signed up via Apple Sign-In).

GET https://api.kulawise.com/api/v1/partners/health-metrics

Query Parameters

Parameter Type Requirement Description
email string Optional* The user's registered Kulawise email address.
username string Optional* The user's Kulawise username (e.g. alex). Ideal for Apple Sign-In accounts.
date string Optional Date in YYYY-MM-DD format. Defaults to today's date.

*At least one of email or username must be provided in the request query.

Sample JSON Response

{
  "email": "user@example.com",
  "username": "alex",
  "user_name": "Alex Chen",
  "date": "2026-10-06",
  "metrics": {
    "steps": 8450,
    "calories_burned": 420,
    "distance_meters": 6200,
    "water_liters": 2.5,
    "calories_consumed": 1850,
    "gym_checkin": {
      "is_checked_in": true,
      "checkin_time": "2026-10-06T08:30:00Z",
      "checkout_time": null
    },
    "points": 1450
  },
  "synced_at": "2026-10-06T02:40:00Z"
}

Code Examples

# Query by username:
curl -X GET "https://api.kulawise.com/api/v1/partners/health-metrics?username=alex" \
  -H "X-Partner-Key: kula_YOUR_SECRET_KEY"

# Or query by email:
curl -X GET "https://api.kulawise.com/api/v1/partners/health-metrics?email=user@example.com" \
  -H "X-Partner-Key: kula_YOUR_SECRET_KEY"