API OverviewAPI EndpointsQbo Contacts

Get QBO contacts

Retrieve QuickBooks Online contacts (customers and vendors) with optional transaction relationships. Returns internal customer/vendor IDs when they exist in the system.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired
Entity ID
contactTypeenumOptional
Filter by contact type
Allowed values:
includeTransactionsbooleanOptional
Include transaction relationships
includeInvoicesbooleanOptional
Include invoice relationships
searchstringOptional
Search contacts by name
limitintegerOptional
Number of contacts to return
offsetintegerOptional
Number of contacts to skip
cursorstringOptional
Cursor for pagination
pageSizeintegerOptional
Page size for cursor pagination

Response

QBO contacts data
successboolean or null
datalist of objects or null