API Reference

Workspace API

The workspace administration API: workspaces, users, customers, wallet configurations, and settings. Use it to manage your Coinbax workspace programmatically.

Base URL (staging)https://core-staging.coinbax.com/api/v1
Base URL (production)https://core.coinbax.com/api/v1
OpenAPI speccoinbax-core.json
Version1.0.0

Authentication

  • bearerAuthBearer token in the Authorization header
  • apiKeyAuthAPI key in the header "X-API-Key"
  • internalApiKeyAPI key in the header "X-Internal-API-Key"

See the authentication guide for how to obtain credentials and the scopes reference for permissions.

Endpoints (67)

Session

The caller's own session lifecycle: who am I, refresh, log out. This is the slice of authentication an integrator needs. Account administration (register, password reset, OAuth account linking) stays private.

  • POST/auth/signup
  • POST/auth/verify-code
  • POST/identity/login
  • POST/identity/logout
  • + 2 more

Workspace Profile

Reads and self-scoped updates of the caller's own workspace and its configuration. Destructive or platform-wide workspace administration (list all, create, delete, avatar) stays private.

  • GET/workspaces/me
  • PUT/workspaces/me
  • GET/workspaces/{id}
  • GET/workspaces/{id}/billing
  • + 6 more

Workspace Customers

Customer management within workspaces

  • GET/workspaces/{id}/customers
  • POST/workspaces/{id}/customers
  • POST/workspaces/{id}/customers/auth/link-wallet
  • POST/workspaces/{id}/customers/auth/login
  • + 4 more

Workspace Transactions

Transaction management within workspaces

  • GET/workspaces/{id}/transactions
  • POST/workspaces/{id}/transactions
  • GET/workspaces/{id}/transactions/{txId}
  • POST/workspaces/{id}/transactions/{txId}/submit-escrow-hash

Workspace Webhooks

Webhook management for workspaces

  • GET/workspaces/{id}/webhooks
  • POST/workspaces/{id}/webhooks
  • GET/workspaces/{id}/webhooks/events/types
  • GET/workspaces/{id}/webhooks/{webhookId}
  • + 7 more

Workspace OAuth

OAuth client management for workspaces

  • GET/workspaces/{id}/oauth/clients
  • POST/workspaces/{id}/oauth/clients
  • GET/workspaces/{id}/oauth/clients/{clientId}
  • DELETE/workspaces/{id}/oauth/clients/{clientId}
  • + 4 more

Smart Contracts

Smart contract management

  • GET/workspaces/{id}/contracts
  • POST/workspaces/{id}/contracts/deployments/{deploymentId}/deprecate
  • GET/workspaces/{id}/contracts/{network}
  • POST/workspaces/{id}/contracts/{network}

Integrations

Third-party integrations

  • GET/workspaces/{id}/integrations
  • POST/workspaces/{id}/integrations
  • POST/workspaces/{id}/integrations/validate
  • POST/workspaces/{id}/integrations/with-config
  • + 5 more

Health

System health checks

  • GET/health
  • GET/health/database
  • GET/health/redis
  • GET/health/storage

Workspace Wallets

  • GET/workspaces/{id}/wallet-accounts
  • POST/workspaces/{id}/wallet-accounts
  • GET/workspaces/{id}/wallet-balances