Get Customer Match Run
GET/api/qbo/customers/match-runs/:matchRun
Get the current state of a customer match run, including its status, the matching configuration snapshot the run was scored with, how many QuickBooks customers were evaluated, proposal counts per confidence bucket, proposal counts per decision status, and the background job log ID for progress tracking.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Run statuses: running, awaiting_review, committing, completed, cancelled, failed.
pending_bucket_counts reflects the actionable review queue (pending and approved proposals per bucket); status_counts shows all proposals in the run by decision status.
Returns 404 if the run does not exist.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.