Customer Groups
Get customer groups
get/v1/customers/groups
Request
- Base URL(relative, and it does not resolve against the document’s source URL)
- Auth
- API key in header sessionKey
- or API key in header clientCode
- or API key in header jwt
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
matchstring
match type of the filtering. Supported values: =, >=, <=, contains, startswith. Default is =
idsinteger[]
group Ids
parentIdsinteger[]
parent group ids
orderinteger
group's order
priceListIdsinteger[]
price list ids
orderBystring
field to order by
orderByDirection'ASC' | 'DESC'
direction to order by
skipinteger
skip n records
takeinteger
items to take, default: 20, max: 100000
withTotalCountboolean
optionally return total number of records in the X-Total-Count response header
Response
OK
Example response
[
{
"added": 1595230999,
"addedby": "k@erp.xyz",
"changed": 1595230999,
"changedby": "k@erp.xyz",
"id": 1234,
"name": {
"ar": " ",
"cs": " ",
"da": " ",
"de": " ",
"el": " ",
"en": " ",
"es": " ",
"et": " ",
"fi": " ",
"fo": " ",
"fr": " ",
"he": " ",
"it": " ",
"lt": " ",
"lv": " ",
"nl": " ",
"no": " ",
"pl": " ",
"ru": " ",
"sv": " ",
"th": " ",
"tr": " ",
"vi": " ",
"zh_Hans": " ",
"zh_Hant": " "
}
}
]Changes
No recorded changes to this operation across all 1 revision of this API.