List Account Groups

Beta

GET/v1/sales/account-groups

This endpoint is idempotent. Learn more

Returns a paginated list of account groups, newest first.

The q search term matches the group's name and description.

Permissions requiredValues:customer_groups:read

The role behind your API key or agent must grant every one of these permissions.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

typeoptional stringenumValues:pricing_grouptype_group

Filters results to account groups of the given type.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of account_group

Resources in this page.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
type_group: used to categorize accounts, such as "Consumers" or "Distributors".

A group's type is fixed when it is created and cannot be changed afterwards.

namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

commission_applied: sales commission is calculated on orders from accounts in this group.
commission_exempt: orders from accounts in this group are exempt from commission.

freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

free_freight: customers within this group will not have to pay for freight.
billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Account Groups

List Account Groups

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAccountGroup = await client.sales.accountGroups.list();

console.log(listAccountGroup.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAccountGroup = await client.sales.accountGroups.list();

console.log(listAccountGroup.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/account-groups?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWNncF82cDR6NTdlOWFsYWYiLCJkIjoiZiJ9.LOmPqlB5Nz13NJpkT-JXClonyPWBhWxlETPe73IOick",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "acgp_6p4z57e9alaf",
      "object": "account_group",
      "type": "type_group",
      "name": "Wholesale Customers",
      "description": null,
      "commission_policy": "commission_applied",
      "freight_policy": "billed_freight",
      "default_lead_time_days": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/account-groups?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWNncF82cDR6NTdlOWFsYWYiLCJkIjoiZiJ9.LOmPqlB5Nz13NJpkT-JXClonyPWBhWxlETPe73IOick",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "acgp_6p4z57e9alaf",
      "object": "account_group",
      "type": "type_group",
      "name": "Wholesale Customers",
      "description": null,
      "commission_policy": "commission_applied",
      "freight_policy": "billed_freight",
      "default_lead_time_days": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Account Groups

Authorization

Query Parameters

Returns

Responses