Skip to Content
API reference

API reference

A flat index of every public endpoint. Base URL: https://api.clooveai.com. Developer (/v1) APIs authenticate with an API key; the management APIs under /api/developer and /api/payment-links use a dashboard session (JWT + RBAC).

Vox · Voice AI

Base path: /v1/vox · Auth: API key
MethodEndpointScope
GET/healthvox:read
GET/callsvox:calls:read
POST/callsvox:calls:create
GET/numbersvox:numbers:read
GET/agentsvox:agents:read

See Vox.

Messaging

Base path: /v1/messaging · Auth: API key
MethodEndpointScope
GET/conversationsmessaging:conversations:read
GET/conversations/:idmessaging:messages:read
POST/conversations/:id/messagesmessaging:messages:send
POST/messages/templatemessaging:messages:send

See Messaging.

Contacts

Base path: /v1/contacts · Auth: API key
MethodEndpointScope
GET/contacts:read
GET/:idcontacts:read
POST/contacts:write
PATCH/:idcontacts:write

See Contacts.

Products

Base path: /v1/products · Auth: API key
MethodEndpointScope
GET/products:read
GET/:idproducts:read
POST/products:write
PATCH/:idproducts:write

See Products.

Orders

Base path: /v1/orders · Auth: API key
MethodEndpointScope
GET/orders:read
GET/:idorders:read
POST/orders:write

See Orders.

Wallet & payouts

Base path: /v1/wallet · Auth: API key
MethodEndpointScope
GET/balancewallet:read
GET/payout-accountspayouts:read
GET/bankspayouts:read
POST/payout-accounts/resolvepayouts:read
POST/payout-accountspayouts:write
GET/withdrawalswallet:withdrawals:read
POST/withdrawalswallet:withdrawals:create

See Wallet & payouts.

Storefront (public)

Base path: /api/storefronts/:slug · Auth: none
MethodEndpointDescription
GET/Get storefront
GET/productsList products
GET/featuredFeatured products
GET/on-saleDiscounted products
GET/promotionsActive promotions
POST/ordersPlace order
POST/orders/:id/bank-transferStart bank transfer
GET/orders/:id/check-paymentCheck payment status
POST/orders/:id/refresh-paymentRefresh payment details
POST/orders/:id/cancel-paymentCancel payment
GET/orders/:id/eventsPayment timeline events

See Storefront.

Checkout (public)

Base path: /api/checkout/:reference · Auth: none
MethodEndpointDescription
GET/Get checkout details
POST/bank-transferStart bank transfer
GET/check-paymentCheck payment status
GET/eventsPayment timeline events
POST/refreshRefresh payment link
POST/cancelCancel checkout

See Checkout.

Base path: /api/payment-links · Auth: JWT + RBAC
MethodEndpointDescription
GET/List payment links
POST/Create payment link
POST/batch-salesCreate batch sales links
POST/walletCreate wallet deposit link
POST/wallet/dynamicCreate dynamic wallet link
GET/walletGet wallet link config
GET/:idGet payment link
PATCH/:idUpdate payment link
DELETE/:idDelete payment link

Developer portal (authenticated)

Base path: /api/developer · Auth: JWT + RBAC (MANAGE_DEVELOPER_KEYS)
MethodEndpointDescription
GET/scopesScope catalog
GET/webhook-eventsWebhook event catalog
GET/appsList developer apps
POST/appsCreate developer app
GET/api-keysList API keys
POST/api-keysCreate API key
GET/api-keys/:idGet API key
PATCH/api-keys/:idUpdate API key
POST/api-keys/:id/rotateRotate API key secret
POST/api-keys/:id/view-secretView API key secret
POST/api-keys/:id/revokeRevoke API key
DELETE/api-keys/:idDelete API key
GET/webhook-endpointsList webhook endpoints
POST/webhook-endpointsCreate webhook endpoint
PATCH/webhook-endpoints/:idUpdate webhook endpoint
POST/webhook-endpoints/:id/disableDisable webhook endpoint
GET/webhook-settingsGet webhook signing settings
POST/webhook-settings/:env/rotate-secretRotate signing secret
POST/webhook-settings/:env/view-secretView signing secret
GET/webhook-deliveriesList webhook deliveries
POST/webhook-deliveries/:id/resendResend a delivery
GET/eventsAudit events
GET/usageUsage analytics

See Developer Portal API.

Webhook delivery format

Cloove POSTs this envelope to your endpoints, signed with the Cloove-Signature header. See Webhooks for the full event catalog and verification.

{
  "id": "evt_9b2e1c7a-...",
  "type": "vox.call.completed",
  "created": "2026-01-15T10:02:02.000Z",
  "environment": "live",
  "data": {
    "callId": "c1a2b3c4-...",
    "status": "completed",
    "direction": "outbound",
    "durationSeconds": 122,
    "recordingUrl": null
  }
}
Last updated on
Portal API