Skip to main content
GET
/
api
/
v1
/
:team_slug
/
:app_slug
/
customer-groups
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "app_id": "<string>",
      "created_at": "<string>",
      "discountPercentage": 123,
      "discountPercentageDecimals": 123,
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "storeGroupId": "<string>",
      "updated_at": "<string>"
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Query Parameters

​
search
string

Search by name

​
sort-order
string

Sort order. Should be one of ASC or DESC. Default DESC

​
sort-key
string

The key to sort on. Can be one of created_at, updated_at, and name (Default is created_at)

​
page
integer

Page number (default is 1)

​
per-page
integer

Amount of customer groups per page. Minimum 0 and max 100 (default is 20)

Response

List of app customer groups

​
data
object[]
​
success
boolean
​
total
integer
​
total_pages
integer