---
title: "Get customer groups"
method: GET
path: "/v1/customers/groups"
tags: ["Customer Groups"]
---

# Get customer groups

`GET /v1/customers/groups`

## Request

- Base URL: `` (relative, and it does not resolve against the document’s source URL)
- URL: `/v1/customers/groups`
- Auth: one of:
  - API key in header `sessionKey`
  - API key in header `clientCode`
  - API key in header `jwt`
- TypeScript: <https://skmtc.dev/erply/apis/crm-api/docs/v1/customers/groups/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `match` string
- `ids` integer[]
- `parentIds` integer[]
- `order` integer
- `priceListIds` integer[]
- `orderBy` string
- `orderByDirection` 'ASC' | 'DESC'
- `skip` integer
- `take` integer
- `withTotalCount` boolean

## Response `200`

OK

- CustomersApiInternalModelsCustomerGroupResponse[]
  - `added` integer: Unix timestamp
  - `addedby` string: username
  - `changed` integer: Unix timestamp
  - `changedby` string: username
  - `id` integer: object ID
  - `name` ModelsTranslatable
    - `ar` string
    - `cs` string
    - `da` string
    - `de` string
    - `el` string
    - `en` string
    - `es` string
    - `et` string
    - `fi` string
    - `fo` string
    - `fr` string
    - `he` string
    - `it` string
    - `lt` string
    - `lv` string
    - `nl` string
    - `no` string
    - `pl` string
    - `ru` string
    - `sv` string
    - `th` string
    - `tr` string
    - `vi` string
    - `zh_Hans` string
    - `zh_Hant` string
  - `order` integer
  - `parentId` integer
  - `priceListId` integer
  - `priceListId2` integer
  - `priceListId3` integer
  - `priceListId4` integer
  - `priceListId5` integer

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/erply/apis/crm-api.md) - [All operations](https://skmtc.dev/erply/apis/crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/erply/apis/crm-api/revisions/36dd4cc370b2?raw)