v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
B2BAccount

Get Users Async

Retrieves a list of user for a B2B account according to any filter criteria and sort options.

get/commerce/customer/b2baccounts/{accountId}/users

Path parameters

accountIdinteger required

Query parameters

startIndexinteger

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional. For example, applications can filter on UserId to get the single record of the current customer.

pageSizeinteger

Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.

sortBystring

The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

filterstring

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

qstring

a quick filter which will search a predefined set of fields for a match

qLimitinteger

limit on quick filter which will search a predefined set of fields for a match

responseGroupsstring

Used to refine the default information returned from a request. To reduce amount of customer account information returned, use the valid response groups: Contacts, CustomerAccountNotes, and OrderSummary. Optional.

responseFieldsstring

limits which fields are returned in the response body

Response

OK

pageCountinteger
pageSizeinteger
startIndexinteger
totalCountinteger