Coinbax Core API

Workspaces

Workspace (tenant) management

View as Markdown

List all workspaces

GET/workspacesBearer token

Retrieve a paginated list of all workspaces. **Permissions:** ADMIN or SUPER_ADMIN only

Query parameters

pageinteger
Page number (1-indexed)
limitinteger
Items per page

Responses

200Workspaces list 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
- dataarray of Workspace
  array of Workspace
  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
- metaobject
  Meta
  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
  paginationPagination
  pageintegerrequired
  Current page number (1-indexed)
  limitintegerrequired
  Items per page
  totalintegerrequired
  Total number of items
  totalPagesintegerrequired
  Total number of pages

{
  "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",
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 50,
      "totalPages": 3
    }
  }
}

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"
  }
}

403Forbidden - insufficient permissions

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 permission to access this resource",
    "statusCode": 403
  },
  "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/api/v1/workspaces \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

Create a new workspace

POST/workspacesBearer token

Create a new workspace (tenant) in the system. **Permissions:** ADMIN or SUPER_ADMIN only

Request body

namestringrequired
Workspace display name
slugstring
URL-friendly identifier (auto-generated if not provided)
emailstring (email)required
Workspace contact email
statusenum"active" · "inactive" · "suspended" · "pending"
Initial workspace status
webhookUrlstring (uri)
Webhook URL for transaction events
walletProviderenum"COINBAX" · "CIRCLE" · "FIREBLOCKS" · "TURNKEY" · "UTILA"
Wallet provider to use
metadataobject
Custom metadata
object
Custom metadata

Responses

201Workspace created 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": "pending",
    "walletProvider": "TURNKEY",
    "metadata": {
      "industry": "fintech"
    },
    "createdAt": "2026-02-24T12:00:00.000Z",
    "updatedAt": "2026-02-24T12:00:00.000Z"
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

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"
  }
}

403Forbidden - insufficient permissions

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 permission to access this resource",
    "statusCode": 403
  },
  "meta": {
    "timestamp": "2026-02-24T12:00:00.000Z",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

409Workspace with this slug already exists

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": "CONFLICT",
    "message": "A workspace with this slug already exists",
    "statusCode": 409
  },
  "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 POST https://core-staging.coinbax.com/api/v1/workspaces \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Corp",
  "email": "contact@acme.com",
  "walletProvider": "TURNKEY",
  "metadata": {
    "industry": "fintech"
  }
}'

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Acme Corp",
    "email": "contact@acme.com",
    "walletProvider": "TURNKEY",
    "metadata": {
      "industry": "fintech"
    }
  }),
});
const result = await response.json();

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/api/v1/workspaces/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/api/v1/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/api/v1/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/api/v1/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/api/v1/workspaces/<id> \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

Update workspace

PUT/workspaces/{id}Bearer token

Update workspace details. **Permissions:** ADMIN or SUPER_ADMIN only

Path parameters

idstring (uuid)required

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"
  }
}

403Forbidden - insufficient permissions

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 permission to access this resource",
    "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 -X PUT https://core-staging.coinbax.com/api/v1/workspaces/<id> \
  -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/api/v1/workspaces/<id>', {
  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();

Delete workspace

DELETE/workspaces/{id}Bearer token

Permanently delete a workspace. **Permissions:** ADMIN or SUPER_ADMIN only **Warning:** This action is irreversible and will delete all associated data.

Path parameters

idstring (uuid)required

Responses

204Workspace deleted successfully (no content)

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

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"
  }
}

403Forbidden - insufficient permissions

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 permission to access this resource",
    "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 -X DELETE https://core-staging.coinbax.com/api/v1/workspaces/<id> \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

Upload workspace avatar

POST/workspaces/{id}/avatarBearer token

Path parameters

idstring (uuid)required

Responses

200Uploaded

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

curlNode.js

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

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

Delete workspace avatar

DELETE/workspaces/{id}/avatarBearer token

Path parameters

idstring (uuid)required

Responses

204Deleted

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

curlNode.js

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

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/avatar', {
  method: 'DELETE',
  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/api/v1/workspaces/<id>/billing \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/api/v1/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/api/v1/workspaces/<id>/platform-mappings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

Create platform mapping

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

Path parameters

idstring (uuid)required

Responses

201Created

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

curlNode.js

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

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

Delete platform mapping

DELETE/workspaces/{id}/platform-mappings/{mappingId}Bearer token

Path parameters

idstring (uuid)required
mappingIdstring (uuid)required

Responses

204Deleted

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

curlNode.js

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

const response = await fetch('https://core-staging.coinbax.com/api/v1/workspaces/<id>/platform-mappings/<mappingId>', {
  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/api/v1/workspaces/<id>/wallet-settings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

const response = await fetch('https://core-staging.coinbax.com/api/v1/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/api/v1/workspaces/<id>/wallet-settings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

Search workspaces

GET/workspaces/searchBearer token

Query parameters

qstringrequired

Responses

200Results

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

curlNode.js

curl https://core-staging.coinbax.com/api/v1/workspaces/search?q=<q> \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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