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 (142)

Authentication

User authentication and session management

  • POST/auth/login
  • POST/auth/register
  • GET/auth/me
  • POST/auth/refresh
  • + 10 more

Workspaces

Workspace (tenant) management

  • GET/workspaces
  • POST/workspaces
  • GET/workspaces/me
  • PUT/workspaces/me
  • + 12 more

Workspace Customers

Customer management within workspaces

  • GET/workspaces/{id}/customers
  • POST/workspaces/{id}/customers
  • POST/workspaces/{id}/customers/auth/register
  • 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/{webhookId}
  • DELETE/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

Customers

Global customer management (admin only)

  • GET/customers
  • POST/customers
  • GET/customers/{id}
  • PUT/customers/{id}
  • + 5 more

Transactions

Global transaction management

  • GET/transactions
  • GET/transactions/{id}
  • GET/transactions/stats

Users

Admin user management

  • GET/users
  • POST/users
  • GET/users/me
  • PUT/users/me
  • + 7 more

Wallet Configs

Wallet provider configuration

  • GET/workspaces/{id}/external-wallet-configs
  • GET/workspaces/{id}/external-wallet-configs/{type}
  • PUT/workspaces/{id}/external-wallet-configs/{type}
  • DELETE/workspaces/{id}/external-wallet-configs/{type}

Notifications

User notifications

  • GET/notifications
  • DELETE/notifications
  • PATCH/notifications/{id}/read
  • POST/notifications/mark-all-read
  • + 3 more

Settings

Application settings

  • GET/settings
  • POST/settings
  • GET/settings/{key}
  • PUT/settings/{key}
  • + 2 more

Audit Logs

Audit log access

  • GET/workspaces/{id}/audit-logs
  • GET/audit-logs
  • GET/audit-logs/{id}
  • GET/audit-logs/export
  • + 1 more

Smart Contracts

Smart contract management

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

Integrations

Third-party integrations

  • GET/workspaces/{id}/integrations
  • POST/workspaces/{id}/integrations
  • GET/workspaces/{id}/integrations/{integrationId}
  • DELETE/workspaces/{id}/integrations/{integrationId}
  • + 5 more

Health

System health checks

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

Onboarding

User onboarding flow

  • GET/onboarding
  • POST/onboarding/complete
  • POST/onboarding/skip
  • POST/onboarding/create-client

Workspace Users

  • GET/workspaces/{id}/users
  • POST/workspaces/me/invite-users

Workspace Wallets

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

Wallet Provider Configs

  • GET/wallet-provider-configs
  • POST/wallet-provider-configs
  • GET/wallet-provider-configs/{id}
  • DELETE/wallet-provider-configs/{id}
  • + 6 more