Launch app

Getting Started

  • Introduction
  • Quick Start
  • Core Concepts

Guides

  • All Guides
  • Creating Campaigns
  • Mission Types
  • Telegram Mini App
  • Verification

API Reference

  • Overview
  • Authentication
  • Campaigns
  • Wallets
  • Webhooks

Resources

  • Pricing
  • Blog
  • Contact

API Reference

ZYNC uses tRPC for type-safe API access. All endpoints are available through the tRPC client.

Getting StartedGuidesAPI Reference
// Base URL
https://api.zyncd.in/trpc

Authentication

Authenticate users via Telegram, Farcaster, or email.

POST
/api/auth/telegram

Authenticate with Telegram initData

POST
/api/auth/callback

OAuth callback handler

GET
/api/auth/session

Get current session

POST
/api/auth/signout

Sign out current user

Campaigns

Create, manage, and query campaigns.

GET
campaigns.list

List campaigns with filters (status, visibility, brand)

GET
campaigns.get

Get a single campaign by ID

POST
campaigns.join

Join a campaign (creates participation)

GET
campaigns.participation

Get user participation for a campaign

GET
campaigns.myParticipations

List all campaigns the user has joined

POST
campaigns.submitMission

Submit mission evidence

POST
campaigns.claim

Claim reward for completed campaign

Wallets

Manage wallet addresses and on-chain operations.

GET
wallets.getMyWallet

Get current user's wallet

POST
wallets.upsertWallet

Register or update wallet address

DELETE
wallets.deleteWallet

Remove wallet from account

Ledger

Query balances, assets, and transaction history.

GET
ledger.getAssets

List available assets

GET
ledger.getMyBalances

Get all balances for current user

GET
ledger.getMyEntries

Get transaction history

POST
ledger.transfer

Transfer balance between identities

Identity

Manage identity providers and profile.

GET
identity.getMe

Get current user's identity

GET
identity.getMyProviders

List linked identity providers

PUT
identity.updateProfile

Link a new identity provider

Webhooks

Receive real-time event notifications.

POST
/webhooks/campaign.completed

Fired when a user completes all campaign missions

POST
/webhooks/reward.claimed

Fired when a reward is claimed

POST
/webhooks/mission.verified

Fired when a mission submission is verified

Rate Limits

API requests are rate limited per identity:

  • Read operations: 100 requests per minute
  • Write operations: 20 requests per minute
  • Financial operations: 5 requests per minute

Need help with the API? Contact our developer support team

TermsPrivacyDocsContact

© 2025 ZYNC. All rights reserved.

Home
Features
Pricing
Docs