Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

accountId
integer<int32>
required

Query Parameters

startIndex
integer<int32>
default:0

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.

pageSize
integer<int32>
default:0

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.

sortBy
string

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.

filter
string

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.

q
string

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

qLimit
integer<int32>

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

responseGroups
string

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.

responseFields
string

limits which fields are returned in the response body

Response

OK

Collection of users in a B2B account.

items
object[] | null
pageCount
integer<int32>
pageSize
integer<int32>
startIndex
integer<int32>
totalCount
integer<int32>