API Reference
REST API

REST API Reference

Base URL: https://api.partylayer.io/v1

All API requests require an x-api-key header.

curl -H "x-api-key: pk_live_xxx" https://api.partylayer.io/v1/apps

Apps

MethodEndpointDescription
GET/appsList apps (paginated)
POST/appsCreate app
GET/apps/:idGet app
PATCH/apps/:idUpdate app
DELETE/apps/:idDelete app

Users

MethodEndpointDescription
GET/usersList users (paginated)
POST/usersCreate user
GET/users/:idGet user
POST/users/me/walletCreate wallet for current user
GET/users/me/walletGet current user's wallet

Query parameters: page, page_size, trust_level, search

API Keys

MethodEndpointDescription
GET/api-keysList API keys
POST/api-keysCreate API key (key shown once)
DELETE/api-keys/:idRevoke API key

Webhooks

MethodEndpointDescription
GET/webhooksList webhooks
POST/webhooksCreate webhook
PATCH/webhooks/:idUpdate webhook
DELETE/webhooks/:idDelete webhook
POST/webhooks/:id/testSend test event
GET/webhooks/:id/deliveriesList deliveries

Authentication

Passkey/WebAuthn

MethodEndpointDescription
POST/auth/passkey/register-optionsGet registration challenge
POST/auth/passkey/register-verifyVerify registration
GET/auth/passkey/login-optionsGet login challenge
POST/auth/passkey/login-verifyVerify login

Telegram

MethodEndpointDescription
POST/auth/telegram/verifyVerify Telegram auth data
GET/auth/telegram/widget-configGet bot config for widget

Guest Sessions

MethodEndpointDescription
POST/guestsCreate guest session
GET/guests/:idGet guest session
POST/guests/:id/convertConvert guest to user
DELETE/guests/:idExpire session
POST/guests/cleanupBulk expire old sessions

Delegated Sessions

MethodEndpointDescription
POST/delegated-sessionsCreate delegated session
GET/delegated-sessions/:idGet session details
DELETE/delegated-sessions/:idRevoke session
POST/delegated-sessions/:id/executeExecute transaction
POST/delegated-sessions/:id/queryQuery contracts

MFA

MethodEndpointDescription
POST/mfa/setupStart MFA setup
POST/mfa/verify-setupComplete MFA setup
POST/mfa/challengeRequest MFA challenge
POST/mfa/verifyVerify MFA code
GET/mfa/statusGet MFA status
DELETE/mfaDisable MFA

MPC Key Management

MethodEndpointDescription
POST/mpc/sharesStore key share
GET/mpc/shares/:walletIdRetrieve key share
DELETE/mpc/shares/:walletIdDelete key shares
POST/mpc/recoverRecover key from shares

Custom Domains

MethodEndpointDescription
POST/custom-domainsRegister domain
POST/custom-domains/verifyVerify DNS ownership
DELETE/custom-domainsRemove domain

Tenant

MethodEndpointDescription
GET/tenantGet current tenant
PATCH/tenantUpdate tenant settings

Analytics

GET /analytics?period=30d

Periods: 7d, 30d, 90d

Billing

MethodEndpointDescription
POST/billing/checkoutCreate Stripe checkout session
POST/billing/portalCreate billing portal session
GET/billing/usageGet current usage

Health

MethodEndpointDescription
GET/healthzHealth check
GET/readyzReadiness check

Response Format

Success

{ "data": { ... } }

Paginated

{
  "data": [...],
  "total": 100,
  "page": 1,
  "pageSize": 50,
  "hasMore": true
}

Error

{
  "error": "Human-readable message",
  "code": "ERROR_CODE",
  "details": []
}

HTTP Status Codes

CodeMeaning
200Success
201Created
400Bad Request / Validation Error
401Unauthorized
403Forbidden (MFA required)
404Not Found
409Conflict (duplicate)
410Gone (expired)
429Rate Limited
500Internal Server Error
Node SDKWebhook Events