API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/integrations/quickbooks/customer-mappings
ark.list_quickbooks_customer_mappings
Lists ARK customers and their QuickBooks customer mapping state for setup, unmapped-entity cleanup, and sync troubleshooting.
- Availability
- Expanded preview
- Scopes
billing:read- ARK permissions
canViewBilling- Team visibility
- Not entity-scoped
- Idempotency-Key
- Not required
- Approval
- No MCP approval on REST API-token calls
- Rate limit
- API credential and organization budgets
Parameters
mapping_statusqueryQuickBooksMappingStatussearchquerystring- min length: 1; max length: 100
limitqueryinteger- default: 25; min: 1; max: 100
offsetqueryinteger- default: 0; min: 0
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/integrations/quickbooks/customer-mappings' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
QuickBooks customer mappings
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.typestringrequiredone of: customer, carrier
data.mappingsarray<object>requireddata.totalCountintegerrequireddata.paginationobjectrequireddata.generatedAtstringrequiredformat: date-time
Errors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied