Coinbax Core API

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.

View as Markdown

Get current user's workspace

GET/workspaces/meBearer token

Retrieve the workspace associated with the currently authenticated user.

Responses

200Workspace retrieved successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataWorkspace
  idstring (uuid)required
  Workspace unique identifier
  namestringrequired
  Workspace display name
  slugstring
  URL-friendly workspace identifier
  emailstring (email)required
  Workspace contact email
  statusenumrequired"active" · "inactive" · "suspended" · "pending"
  Workspace status
  avatarPathstring
  Path to workspace avatar image
  webhookUrlstring (uri)
  Webhook URL for transaction events
  walletProviderenum"COINBAX" · "CIRCLE" · "FIREBLOCKS" · "TURNKEY" · "UTILA"
  Primary wallet provider for this workspace
  walletIdstring
  Wallet identifier from the wallet provider
  turnkeyOrganizationIdstring
  Turnkey organization ID (if using Turnkey)
  metadataobject
  Additional custom metadata (key-value pairs)
  object
  Additional custom metadata (key-value pairs)
  billingEnabledboolean
  Whether billing is enabled for this workspace
  createdAtstring (date-time)required
  Workspace creation timestamp
  updatedAtstring (date-time)required
  Last update timestamp

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "email": "contact@acme.com",
    "status": "active",
    "walletProvider": "TURNKEY",
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-20T14:30:00.000Z"
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

400User has no associated workspace

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "BAD_REQUEST",
    "message": "Client ID not found for this user",
    "statusCode": 400
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl https://core-staging.coinbax.com/workspaces/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/me', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

Update current user's workspace

PUT/workspaces/meBearer token

Update the workspace associated with the currently authenticated user. Allows workspace members to update their own organization details.

Request body

namestring
Workspace display name
emailstring (email)
Workspace contact email
statusenum"active" · "inactive" · "suspended" · "pending"
Workspace status
avatarPathstring
Path to workspace avatar image
webhookUrlstring (uri)
Webhook URL for transaction events
walletProviderenum"COINBAX" · "CIRCLE" · "FIREBLOCKS" · "TURNKEY" · "UTILA"
Wallet provider to use
metadataobject
Custom metadata
object
Custom metadata

Responses

200Workspace updated successfully

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataWorkspace
  idstring (uuid)required
  Workspace unique identifier
  namestringrequired
  Workspace display name
  slugstring
  URL-friendly workspace identifier
  emailstring (email)required
  Workspace contact email
  statusenumrequired"active" · "inactive" · "suspended" · "pending"
  Workspace status
  avatarPathstring
  Path to workspace avatar image
  webhookUrlstring (uri)
  Webhook URL for transaction events
  walletProviderenum"COINBAX" · "CIRCLE" · "FIREBLOCKS" · "TURNKEY" · "UTILA"
  Primary wallet provider for this workspace
  walletIdstring
  Wallet identifier from the wallet provider
  turnkeyOrganizationIdstring
  Turnkey organization ID (if using Turnkey)
  metadataobject
  Additional custom metadata (key-value pairs)
  object
  Additional custom metadata (key-value pairs)
  billingEnabledboolean
  Whether billing is enabled for this workspace
  createdAtstring (date-time)required
  Workspace creation timestamp
  updatedAtstring (date-time)required
  Last update timestamp

{
  "success": true,
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "email": "contact@acme.com",
    "status": "active",
    "avatarPath": "/uploads/avatars/workspace-123.png",
    "webhookUrl": "https://acme.com/webhooks/coinbax",
    "walletProvider": "TURNKEY",
    "walletId": "wallet_abc123",
    "turnkeyOrganizationId": "org_turnkey_xyz",
    "metadata": {
      "industry": "fintech",
      "tier": "enterprise"
    },
    "billingEnabled": false,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-20T14:30:00.000Z"
  }
}

400Bad request - validation error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "statusCode": 400,
    "details": {
      "email": "Invalid email format"
    }
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl -X PUT https://core-staging.coinbax.com/workspaces/me \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Corporation",
  "email": "admin@acme.com",
  "webhookUrl": "https://acme.com/webhooks/coinbax-v2"
}'

const response = await fetch('https://core-staging.coinbax.com/workspaces/me', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Acme Corporation",
    "email": "admin@acme.com",
    "webhookUrl": "https://acme.com/webhooks/coinbax-v2"
  }),
});
const result = await response.json();

Get workspace by ID

GET/workspaces/{id}Bearer token

Retrieve a workspace by its unique identifier. **Permissions:** - User must be a member of the workspace OR - User must be ADMIN or SUPER_ADMIN

Path parameters

idstring (uuid)required
Workspace UUID

Responses

200Workspace found

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataWorkspace
  idstring (uuid)required
  Workspace unique identifier
  namestringrequired
  Workspace display name
  slugstring
  URL-friendly workspace identifier
  emailstring (email)required
  Workspace contact email
  statusenumrequired"active" · "inactive" · "suspended" · "pending"
  Workspace status
  avatarPathstring
  Path to workspace avatar image
  webhookUrlstring (uri)
  Webhook URL for transaction events
  walletProviderenum"COINBAX" · "CIRCLE" · "FIREBLOCKS" · "TURNKEY" · "UTILA"
  Primary wallet provider for this workspace
  walletIdstring
  Wallet identifier from the wallet provider
  turnkeyOrganizationIdstring
  Turnkey organization ID (if using Turnkey)
  metadataobject
  Additional custom metadata (key-value pairs)
  object
  Additional custom metadata (key-value pairs)
  billingEnabledboolean
  Whether billing is enabled for this workspace
  createdAtstring (date-time)required
  Workspace creation timestamp
  updatedAtstring (date-time)required
  Last update timestamp

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "email": "contact@acme.com",
    "status": "active",
    "walletProvider": "TURNKEY",
    "webhookUrl": "https://acme.com/webhooks/coinbax",
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-20T14:30:00.000Z"
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

401Unauthorized - missing or invalid authentication

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required",
    "statusCode": 401
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

403Access denied - not a member of this workspace

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this workspace",
    "statusCode": 403
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

404Resource not found

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "statusCode": 404
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500Internal server error

successenumrequiredfalse
Always false for error responses
dataobject
Always null for error responses
object
Always null for error responses
errorErrorrequired
- codestringrequired
  Machine-readable error code
- messagestringrequired
  Human-readable error message
- statusCodeintegerrequired
  HTTP status code
- detailsobject
  Additional error details (optional)
  object
  Additional error details (optional)
metaMetarequired
- timestampstring (date-time)required
  Response timestamp
- requestIdstringrequired
  Unique request identifier for debugging
- paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred",
    "statusCode": 500
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curlNode.js

curl https://core-staging.coinbax.com/workspaces/<id> \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/<id>', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

Get workspace billing

GET/workspaces/{id}/billingBearer token

Path parameters

idstring (uuid)required

Responses

200Retrieved

Response follows the unified success / data / meta / error envelope.

curlNode.js

curl https://core-staging.coinbax.com/workspaces/<id>/billing \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/<id>/billing', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

List platform mappings

GET/workspaces/{id}/platform-mappingsBearer token

Path parameters

idstring (uuid)required

Responses

200Retrieved

Response follows the unified success / data / meta / error envelope.

curlNode.js

curl https://core-staging.coinbax.com/workspaces/<id>/platform-mappings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/<id>/platform-mappings', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

List sandbox API keys for a workspace

GET/workspaces/{id}/sandbox-credentialsBearer token

Path parameters

idstring (uuid)required

Responses

200Sandbox credentials returned (never the key material)

Response follows the unified success / data / meta / error envelope.

401Missing or invalid access token

Response follows the unified success / data / meta / error envelope.

curlNode.js

curl https://core-staging.coinbax.com/workspaces/<id>/sandbox-credentials \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/<id>/sandbox-credentials', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

Issue sandbox credentials

POST/workspaces/{id}/sandbox-credentialsBearer token

Issues a sandbox credential pair for staging: an OAuth client for the Payments API **v2**, and an API key that works on **v1** until it sunsets on 2026-11-01. Both the key and the OAuth client secret are returned exactly once and are not retrievable afterwards — store them when issued. Use `oauthClient` for `/api/v2`: v2 accepts OAuth 2.0 Bearer tokens only. Exchange the client credentials at `POST https://api-staging.coinbax.com/api/v2/oauth/token`. Limits: 2 active credentials per workspace, and issuance is rate limited to 5 per hour.

Path parameters

idstring (uuid)required

Responses

201Credentials issued; returned once and never again

SuccessResponse
- successenumrequiredtrue
  Always true for successful responses
- dataobjectrequired
  Response data (structure varies by endpoint)
- metaMetarequired
  timestampstring (date-time)required
  Response timestamp
  requestIdstringrequired
  Unique request identifier for debugging
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages
object
- dataobject
  platformIdstring (uuid)required
  namestringrequired
  Derived from the workspace slug.
  apiKeystringrequired
  v1 only. Shown once. The Payments API v2 rejects API keys — use `oauthClient` instead.
  oauthClientobject
  Credentials for `/api/v2`. Absent only if client creation failed, in which case this credential works on `/api/v1` only and the `warning` field says so.
  clientIdstringrequired
  clientSecretstringrequired
  Shown once, never re-disclosed.
  scopesarray of stringrequired
  array of string
  string
  scopesarray of stringrequired
  Fixed server-side set; never caller input. Includes the v2 money-moving scopes `move:transactions` and `reverse:transactions`.
  array of string
  string
  createdAtstring (date-time)required
  warningstring
  Human-readable one-time-disclosure notice.

{
  "success": true,
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "data": {
    "platformId": "9f8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
    "name": "string",
    "apiKey": "string",
    "oauthClient": {
      "clientId": "string",
      "clientSecret": "string",
      "scopes": [
        "string"
      ]
    },
    "scopes": [
      "string"
    ],
    "createdAt": "2026-01-15T12:00:00.000Z",
    "warning": "string"
  }
}

401Missing or invalid access token

Response follows the unified success / data / meta / error envelope.

409The 2-active credential limit is reached. Revoke one before issuing another.

Response follows the unified success / data / meta / error envelope.

429Issuance rate limit reached (5 per hour)

Response follows the unified success / data / meta / error envelope.

curlNode.js

curl -X POST https://core-staging.coinbax.com/workspaces/<id>/sandbox-credentials \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/<id>/sandbox-credentials', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

Revoke a sandbox API key

DELETE/workspaces/{id}/sandbox-credentials/{platformId}Bearer token

Path parameters

idstring (uuid)required
platformIdstring (uuid)required

Responses

204Key revoked

Response follows the unified success / data / meta / error envelope.

404No such credential on this workspace

Response follows the unified success / data / meta / error envelope.

curlNode.js

curl -X DELETE https://core-staging.coinbax.com/workspaces/<id>/sandbox-credentials/<platformId> \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/<id>/sandbox-credentials/<platformId>', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

Get wallet settings

GET/workspaces/{id}/wallet-settingsBearer token

Path parameters

idstring (uuid)required

Responses

200Retrieved

Response follows the unified success / data / meta / error envelope.

curlNode.js

curl https://core-staging.coinbax.com/workspaces/<id>/wallet-settings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/<id>/wallet-settings', {
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();

Update wallet settings

PATCH/workspaces/{id}/wallet-settingsBearer token

Path parameters

idstring (uuid)required

Responses

200Updated

Response follows the unified success / data / meta / error envelope.

curlNode.js

curl -X PATCH https://core-staging.coinbax.com/workspaces/<id>/wallet-settings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/workspaces/<id>/wallet-settings', {
  method: 'PATCH',
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
});
const result = await response.json();