List Account Groups

Beta
GET/v1/sales/account-groups

This endpoint is idempotent. Learn more

Returns a paginated list of account groups.

cursoroptional string

Cursor token used to retrieve the next or previous page of results.

limitoptional integer

Maximum number of results per page (default: 100, max: 1000).

qoptional string

Search query used to filter results.

typeoptional stringenumValues:pricing_grouptype_group

Account group type filter.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

namestring

Display name.

descriptionstringnullable

Description.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policystringenumValues:free_freightbilled_freight

Freight policy.

typestringenumValues:pricing_grouptype_group

Account 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

200

Successful response for List Account Groups