List Account Groups
Beta/v1/sales/account-groupsThis endpoint is idempotent. Learn more
Returns a paginated list of account groups.
cursoroptional stringCursor token used to retrieve the next or previous page of results.
limitoptional integerMaximum number of results per page (default: 100, max: 1000).
qoptional stringSearch query used to filter results.
typeoptional stringenumValues:pricing_grouptype_groupAccount group type filter.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableURL to fetch the next page, null if no more pages.
previous_page_urlstringnullableURL to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectResources in this page.
idstringAccount group ID.
objectstringenumValues:account_groupResource type identifier.
namestringDisplay name.
descriptionstringnullableDescription.
commission_policystringenumValues:commission_appliedcommission_exemptCommission policy.
freight_policystringenumValues:free_freightbilled_freightFreight policy.
typestringenumValues:pricing_grouptype_groupAccount group type.
The type pricing_group indicates this account group is utilized for pricing rules. For example, you may have a 'Preferred' price group that receives a special discount rate. The type type_group indicates the account group is utilized to categorize a set of accounts. For example, you may have a group of accounts that are 'Consumers' or 'Distributors'.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Responses
Successful response for List Account Groups