BIbill
customers

Get list of customers

Changed on

Get a list of customer objects. By default, you get 20 results on one page of results. Set max in your request to get up to 100 results on one page.

See Search operations with lists in the Guides section for filtering, sorting, and pagination examples.

get/v3/customers

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/customers
  • Auth
    none declared

Query parameters

maxinteger nullable

Maximum number of results

Example:10
sortstring nullable

Field name and sort order. Both simple and compound sorting is available.

The format is sort={field_01}:{sort_order},{field_02}:{sort_order}.

NOTE: Sorting occurs in the specified order.

Example:createdTime:desc
filtersstring nullable

Field name, operator, and value. Both simple and compound filtering is available.

The format is filters={field_01}:{op}:{value},{field_02}:{op}:{value}.

The fz operator performs a fuzzy match and is supported only on name, for example filters=name:fz:acme corp. It returns active customers whose names approximately match the search term, ordered by the other sort criteria. A fuzzy search returns the best matches up to the page size and does not page: following nextPage returns an empty page.

Example:id:eq:{{customer_id}}
pagestring nullable

Next page of results.

When a list has multiple pages, the nextPage and prevPage values in the response enable you to navigate between the pages of results. Set page as the nextPage or prevPage value for navigation.

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Get list of customers response

nextPagestring
prevPagestring

Changes

  • 54edddceb0a5Revision changes
    • info

      added the optional property ////// to the response with the status