Skip to main content

Filtering (Query)

To filter the result set, the following comparison operators can be used:

  • EQUALS (equals)

  • GT (greater than)

  • LT (less than)

  • GTE (greater than or equal to)

  • LTE (less than or equal to)

  • CONTAINS (find strings containing this string)

  • NOTEQUALS (not equals)

  • IS:NULL (is null/unset)

  • ISNOT:NULL (is NOT null)

API Examples

// Get customers with an e-mail address of "johndoe@example.com"
/api/v3/customer?where=superuser_email:EQUALS:johndoe@example.com

// Get customers with the word "test" in their company name
/api/v3/customer?where=company:CONTAINS:test

// Get a list of invoices on "2015-02-05" (Feb 5, 2015)
/api/v3/invoice?where=date:EQUALS:2015-02-05

// Get a list of invoices between the two dates "2015-02-01" (Feb 1, 2015) and "2015-02-05" (Feb 5, 2015)
/v3/invoice?where=date:GTE:2015-02-01,date:LTE:2015-02-05