API Request: Retrieve Customer Group
Method: GET
Endpoint: {{url}}/api/resource/Customer Group
Description
This endpoint retrieves customer groups from the API. It allows you to filter the results based on specific criteria. In this case, the filter applied is to retrieve customer groups where the is_group field is equal to 0.
Query Parameters
filters: This parameter specifies the conditions for filtering the customer groups. The value should be a JSON array of filter conditions. For example,filters=[["is_group", "=", "0"]]retrieves customer groups that are not classified as groups.
Expected Response Format
The response will be in JSON format and will include a data array containing the customer group objects. Each object may contain various fields, such as name. An example response is as follows:
{
"data": [
{
"name": ""
}
]
}
This response indicates that the request was successful, and the data array contains the relevant customer group information based on the specified filters.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Response
The response returns a collection of customer group records wrapped inside a data array.
Each record represents a category used to classify customers.
Example Response
{
"data": [
{
"name": "All Customer Groups"
},
{
"name": "Individual"
},
{
"name": "Commercial"
},
{
"name": "Non Profit"
},
{
"name": "Government"
},
{
"name": "Dealer"
},
{
"name": "Shop Customer"
}
]
}