Skip to main content
GET
List Customers
Retrieve a paginated list of customer records. Use filters to narrow results by ID or last-modified date range.
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.fffZ
string
Filter by last modified date (end). Format: yyyy-MM-ddTHH:mm:ss.fffZ
string
Sort order: asc or desc
integer
Number of records to return
integer
Zero-based offset for pagination
Response is a paginated result with from, to, length, and items (array of CustomerSearchResult). CustomerSearchResult fields Example 200 Response

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

API Key authentication header

Accept-Encoding
string
default:gzip

Pass 'gzip' to receive compressed response.

Query Parameters

CustomerId
string

Narrow the Filter search by specifying NBI Customer Id.

DateUpdatedStart
string<date-time>

The Customer Last Modified Date to Start Search from (UTC). Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'

DateUpdatedEnd
string<date-time>

The Customer Last Modified Date to End Search from (UTC). Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'

Sort
enum<string>

Sort result in Ascending or Descending order by FirstName and LastName.

Available options:
Asc,
Desc
Limit
integer<int32>

Max number of records to return, default is 100, max is 100.

Required range: 1 <= x <= 100
StartIndex
integer<int32>

Number of matching records to skip before returning the matches, default is 0.

Response

200 - application/json

Get Customers

from
integer<int64>
to
integer<int64>
length
integer<int64>
items
object[] | null