Skip to main content
GET
Query Customers

Authorizations

Authorization
string
header
required

Use your app's API_KEY as the username, and leave the password blank

Path Parameters

connection_id
string<uuid>
required

ID of the connection to use for the query

Query Parameters

request_id
string

A custom ID that can be used to identify the request and response. This could be your local ID for the request.

Example:

"1"

max_returned
integer

Maximum number of results to return

include[]
enum<string>[]

List of fields for QuickBooks to include in the response. Full list of possible values at

Available options:
FullName,
ListID,
etc
name
string

Filter customers by name (partial match, case-insensitive)

from_name
string

Filter customers with names starting from this value (inclusive)

to_name
string

Filter customers with names up to this value (inclusive)

from_modified_date
string<date-time>

Filter customers modified after this date/time (ISO 8601 format)

to_modified_date
string<date-time>

Filter customers modified before this date/time (ISO 8601 format)

active
enum<string>
default:ActiveOnly

Filter customers by active status

Available options:
ActiveOnly,
InactiveOnly,
All
webhook_url
string<uri>

Optional URL to receive a webhook when the request is completed

Response

Query accepted and queued for processing. Returns a queued request object.

data
object