sale/customer_group/get
POST/sale/customer_group/getThis returns the list of customer groups available in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The customer group ID to search for specifically.
Filter the list of customer groups by name.
Filter the list of customer groups modified after the spcified date.
Filter the list of customer groups to include deleted records.
Page number of the results.
The key for the ordering of the results. Accepts "name", "date_modified"
The direction for the ordering of the results. Accepts "ASC", "DESC"
The number of results per page. Accepts 1 to 100.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"customer_group_id": 0,
"filter_name": "string",
"filter_date_modified": "string",
"filter_deleted": true,
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}Responses
Returns only if there is an error.
The total number of results available.
The list of customer groups.
The customer group ID.
The customer group name.
The date time this customer group was last modified.
Indicates if the customer group has been deleted. Only returned if filter_deleted is "1".
{
"error": [
"string"
],
"total": 0,
"customer_groups": [
{
"customer_group_id": 0,
"name": "string",
"date_modified": "string",
"deleted": true
}
]
}