Skip to main content

Get Numeral Connection

GET 

/api/numeral/instances/:instance

Returns the Numeral connection: mode, masked key, health (connection_status connected | error | disconnected, connection_error auth_error | production_key_on_non_production | null), settings (including live_calculation_enabled and live_calculation_enabled_at, when live tax calculation for SKU.io orders was last turned on), every sales channel with its tax-collection responsibility (responsibility is null while the channel is unclassified), whether it is included and its order count since the start date, record counts by status, and permissions.can_classify_channels (whether the current user may set a channel's tax-collection responsibility, which requires the accounting.manage_tax_settings permission). The API key is never returned.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires a Bearer token. Requires the integrations.show permission.

Request​

Responses​

OK

Response Headers
    Content-Type