Skip to content

List an integration's error log

Open .md

GET/v1/api/store/{team_slug}/setting/external_integration/{id}/logs

v1Operation ID v1_public_external_integration_logs

Returns the sync errors an integration recorded, newest first, a page at a time (the team's page size). Only QuickBooks Online keeps a log here (has_logs: true); for every other integration the answer is data: null.

Each entry has type, error_code, error_message, error_payload, retryable and created_at, and names the order it is about in order (or null). A QuickBooks payment that is held gets one entry per hold, with the QuickBooks Payment in quickbooks_payment_id and QuickBooks' own words in quickbooks_message. Provider answers are logged with secrets removed. The {id} is the integration's id from the list.

Permission

Any member of the team, whatever their role. This is wider than the web app, whose Settings pages need Manage Settings: on the API only changes need it. AI apps (MCP connections) need Manage Settings to read it.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team
  • idstringrequired

    The integration, from the integration list. Its hash id from an earlier answer; there is no unique key for it.

    • Example d9ZxWgBz09mDFq

Request body

This operation takes no request body.

Response

200Successful response.

  • dataarray of objectsrequired
    Fields of each item (11)
    • created_atstring (date-time)
    • error_codestring | null
    • error_messagestring | null
    • error_payloadobject | array | string | null

      What the provider sent back, when it did: for a QuickBooks refusal, QuickBooks' detail text.

    • idstring
    • orderobject | null

      The sales order or quote the entry is about, or null.

      Child fields (4)
      • deletedbooleanrequired
      • idstringrequired

        The order's id, as the order operations take it.

      • scoped_idstringrequired

        The number people see, such as SO1001. Not an id.

      • typestringrequired
        • One of: "sales_order", "quote"
    • quickbooks_messagestring | null

      What QuickBooks said, when it refused a payment.

    • The QuickBooks Payment the entry is about, when it is about one.

    • retryableboolean
    • typestring
  • statusintegerrequired
  • successbooleanrequired
  • Child fields (6)
    • countintegerrequired
    • currentPageintegerrequired
    • perPageintegerrequired
    • totalintegerrequired
    • totalPagesintegerrequired

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

    When
    No integration of your team has this id. error.code is null; error.message names the record type.
    Fix
    Use an id from the list.
  • 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

    When
    Shopify is not in your plan (plan_limitation).
    Fix
    Upgrade the plan.
  • GETGet an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}