Connection Status

Check connection status

After completing the QWC setup, use the status endpoint to confirm the connector has checked in and your company file is live.

curl "https://api.nx-us.net/api/v1/qwc-auth-setup/{connectionId}/status" \
  -H "Authorization: Bearer sk_live_..."

// 200 OK — connected
{
  "connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isConnected": true,
  "lastSyncAt": "2025-06-10T14:32:00Z",
  "companyName": "Acme Corp",
  "isSampleFile": false
}

Response fields

Field	Type	Description
connectionId	string (uuid)	Unique identifier for this connection.
isConnected	boolean | null	True once the QWC has checked in at least once.
lastSyncAt	string (ISO 8601)	Timestamp of the most recent successful sync.
companyName	string | null	Company name from the QuickBooks company file.
isSampleFile	boolean	True if connected to a QuickBooks sample file.

⚠️ isSampleFile: true — Your sk_test_ key is working correctly but you’re reading demo data. Switch to a real company file and a sk_live_ key for production.

List all connections

curl "https://api.nx-us.net/api/v1/connections" \
  -H "Authorization: Bearer sk_live_..."

// 200 OK
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "nXus QuickBooks Desktop connection",
      "createdAt": "2025-06-01T10:00:00Z"
    }
  ]
}

Delete a connection

Deleting a connection removes all associated QWC credentials. The Web Connector will stop syncing on its next poll attempt. Make sure to remove the corresponding .qwc entry from the QuickBooks machine to clean up.

curl -X DELETE "https://api.nx-us.net/api/v1/connections/{connectionId}" \
  -H "Authorization: Bearer sk_live_..."

⚠️ Deletion is immediate and irreversible. You’ll need to create a new connection and repeat the QWC setup process if you want to reconnect the same company file.