Coinbax Core API

Settings

Application settings

View as Markdown

List global settings

GET/settingsBearer token

Retrieve global settings. Encrypted values are returned as empty strings. **Permissions:** ADMIN or SUPER_ADMIN only

Query parameters

categorystring
Filter by category
pageinteger
limitinteger

Responses

200Settings 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
- dataobject
  settingsarray of GlobalSetting
  array of GlobalSetting
  idstring (uuid)
  keystring
  Setting key
  valuestring
  Setting value (empty string if encrypted)
  categorystring
  Setting category
  descriptionstring
  Setting description
  isEncryptedboolean
  Whether the value is encrypted
  createdAtstring (date-time)
  updatedAtstring (date-time)
  metaobject
  pageinteger
  limitinteger
  totalinteger
  totalPagesinteger

{
  "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": {
    "settings": [
      {
        "id": "9f8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
        "key": "coinbax_api_key",
        "value": "",
        "category": "api",
        "description": "string",
        "isEncrypted": true,
        "createdAt": "2026-01-15T12:00:00.000Z",
        "updatedAt": "2026-01-15T12:00:00.000Z"
      }
    ],
    "meta": {
      "page": 100,
      "limit": 100,
      "total": 100,
      "totalPages": 100
    }
  }
}

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/settings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

Create or update global setting

POST/settingsBearer token

Create a new global setting or update an existing one. **Permissions:** ADMIN or SUPER_ADMIN only

Request body

keystringrequired
Unique setting key
valuestringrequired
Setting value
categorystring
Setting category
descriptionstring
Setting description
isEncryptedboolean
Whether to encrypt the value

Responses

201Setting 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
- dataGlobalSetting
  idstring (uuid)
  keystring
  Setting key
  valuestring
  Setting value (empty string if encrypted)
  categorystring
  Setting category
  descriptionstring
  Setting description
  isEncryptedboolean
  Whether the value is encrypted
  createdAtstring (date-time)
  updatedAtstring (date-time)

{
  "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": "9f8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
    "key": "coinbax_api_key",
    "value": "",
    "category": "api",
    "description": "string",
    "isEncrypted": true,
    "createdAt": "2026-01-15T12:00:00.000Z",
    "updatedAt": "2026-01-15T12:00: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"
  }
}

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/settings \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "custom_setting",
  "value": "setting_value",
  "category": "general",
  "description": "A custom setting",
  "isEncrypted": false
}'

const response = await fetch('https://core-staging.coinbax.com/api/v1/settings', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "key": "custom_setting",
    "value": "setting_value",
    "category": "general",
    "description": "A custom setting",
    "isEncrypted": false
  }),
});
const result = await response.json();

Get setting

GET/settings/{key}Bearer token

Path parameters

keystringrequired

Responses

200Retrieved

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

curlNode.js

curl https://core-staging.coinbax.com/api/v1/settings/<key> \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

Update setting

PUT/settings/{key}Bearer token

Path parameters

keystringrequired

Responses

200Updated

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

curlNode.js

curl -X PUT https://core-staging.coinbax.com/api/v1/settings/<key> \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

List global settings

GET/global-settingsBearer token

Responses

200Retrieved

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

curlNode.js

curl https://core-staging.coinbax.com/api/v1/global-settings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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

Update settings bulk

POST/global-settings/bulkBearer token

Responses

200Updated

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

curlNode.js

curl -X POST https://core-staging.coinbax.com/api/v1/global-settings/bulk \
  -H "Authorization: Bearer $ACCESS_TOKEN"

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