API

The Zing Partner API lets you integrate server-to-server with Zing to read user data, workouts, tests, body composition, and usage. Use it for dashboards, support tooling, reconciliation, and backfill. It applies to all partners, whether you use the SDK or other integration paths.

How it works

• Webhooks — Zing sends you near-real-time notifications when something changes (e.g. workout completed, user deleted). Use webhooks to stay fresh.
• Pull API — REST endpoints are the source of truth. Use them to fetch the latest data, backfill after missed webhooks, and power your own UI or reports.

Rule of thumb: Webhooks tell you that something changed; the Pull API gives you the correct data. Always use the Pull API when you need the authoritative state (e.g. after receiving a webhook, fetch the resource by ID).

What you’ll find here

• Pull — Authentication, base URL, pagination, and endpoint coverage (status, users, workouts, tests, body composition, usage, webhook deliveries).
• Webhooks — Signing, delivery behavior, event types, and how to implement a robust consumer.
• Reference — Full OpenAPI 3.1 contract: all Pull endpoints, request/response schemas, and webhook event payloads. Opens in a new window (different UI). Use it for code generation, Postman import, or exhaustive parameter and schema details.

When to use the API

• You need to show Zing data in your own dashboards or support tools.
• You want to sync Zing data into your backend or data warehouse.
• You are building a webhook consumer and need to fetch full resource details after receiving an event.
• You need to reconcile or backfill data (e.g. using the webhook delivery audit plus Pull API).

Get your API key and webhook secret from the Admin UI. Then start with Pull for your first request, Webhooks to receive events, and the Reference for the complete API contract (opens in new window).