List Customers
Customers
GET /Customers
Retrieve a paginated list of customer records.
GET
List Customers
Retrieve a paginated list of customer records. Use filters to narrow results by ID or last-modified date range.
Response is a paginated result with
string
required
Your API key
string
Filter to a specific customer by ID
string
Filter by last modified date (start). Format:
yyyy-MM-ddTHH:mm:ss.fffZstring
Filter by last modified date (end). Format:
yyyy-MM-ddTHH:mm:ss.fffZstring
Sort order:
asc or descinteger
Number of records to return
integer
Zero-based offset for pagination
from, to, length, and items (array of CustomerSearchResult).
CustomerSearchResult fields
Example 200 Response
Authorizations
Headers
API Key authentication header
Pass 'gzip' to receive compressed response.
Query Parameters
Narrow the Filter search by specifying NBI Customer Id.
The Customer Last Modified Date to Start Search from (UTC). Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'
The Customer Last Modified Date to End Search from (UTC). Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'
Sort result in Ascending or Descending order by FirstName and LastName.
Available options:
Asc, Desc Max number of records to return, default is 100, max is 100.
Required range:
1 <= x <= 100Number of matching records to skip before returning the matches, default is 0.