GET/api/v1/integrations/quickbooks/health

Get integration health

Returns integration health summary from QuickBooksService. Both /api/v1/integrations/quickbooks/* and /api/v1/quickbooks/* map to the same ApiQuickBooksController method (getHealth). This family uses route handlers that instantiate ApiQuickBooksController and usually wrap calls in explicit try/catch handleApiError blocks.

RBAC · quickbooks

Response body

Success response 200 · schema QuickBooksV1ApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

QuickBooks operation succeeded.

400

Validation or request parsing failure.

401

API key missing/invalid or associated user missing.

403

QuickBooks RBAC permission denied.

500

Unexpected QuickBooks endpoint failure.

GET /api/v1/integrations/quickbooks/health

cURL

curl -X GET "https://algapsa.com/api/v1/integrations/quickbooks/health" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/integrations/quickbooks/health", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/integrations/quickbooks/health");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}