---
updatedAt: 2026-10-07T13:58:45.000Z
agentTools:
  projectIndex: https://developer.intellistack.com/llms.txt
---

# Get the brand membership groups

Get the brand membership groups

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Avatar": {
        "properties": {
          "contentType": {
            "description": "MIME type of the image",
            "type": "string"
          },
          "fileId": {
            "description": "File ID in the file upload service",
            "type": "string"
          },
          "height": {
            "description": "Display height in pixels",
            "type": "integer"
          },
          "sizeBytes": {
            "description": "File size in bytes",
            "format": "int64",
            "type": "integer"
          },
          "url": {
            "description": "Public URL of the avatar image",
            "type": "string"
          },
          "width": {
            "description": "Display width in pixels",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "GroupListingGroup": {
        "properties": {
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "numberOfUsers": {
            "type": "integer"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "userDetails": {
            "items": {
              "properties": {
                "avatarUrl": {
                  "$ref": "#/components/schemas/Avatar"
                },
                "firstName": {
                  "type": "string"
                },
                "lastName": {
                  "type": "string"
                }
              },
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          }
        },
        "type": "object"
      },
      "GroupListingResponse": {
        "properties": {
          "content": {
            "items": {
              "$ref": "#/components/schemas/GroupListingGroup"
            },
            "type": "array"
          },
          "page": {
            "$ref": "#/components/schemas/PageEnvelope"
          }
        },
        "type": "object"
      },
      "PageEnvelope": {
        "properties": {
          "number": {
            "deprecated": true,
            "description": "Renamed pageNumber for v1",
            "type": "integer"
          },
          "pageNumber": {
            "description": "The current page number",
            "type": "integer"
          },
          "pageSize": {
            "description": "How many elements are intended to be on each page",
            "type": "integer"
          },
          "size": {
            "description": "V0: acts same as pageSize. v1: How many elements are on this particular page",
            "type": "integer"
          },
          "totalElements": {
            "description": "The total number of elements accross all pages",
            "type": "integer"
          },
          "totalPages": {
            "description": "The total number of pages available",
            "type": "integer"
          }
        },
        "required": [
          "size"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "JWT",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "API documentation for Core Services",
    "title": "User Management API",
    "version": "0.0.0"
  },
  "openapi": "3.0.0",
  "paths": {
    "/v1/brand-memberships/{brandId}/groups": {
      "get": {
        "description": "Get the brand membership groups",
        "operationId": "getBrandMembershipGroups",
        "parameters": [
          {
            "in": "path",
            "name": "brandId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "description": "How many elements are intended to be on each page",
            "in": "query",
            "name": "pageSize",
            "required": false,
            "schema": {
              "default": 50,
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "description": "The current page number",
            "in": "query",
            "name": "pageNumber",
            "required": false,
            "schema": {
              "default": 1,
              "minimum": 0,
              "type": "integer"
            }
          },
          {
            "description": "Field by which the sorting should be applied",
            "in": "query",
            "name": "sortField",
            "required": false,
            "schema": {
              "default": "createdAt",
              "enum": [
                "id",
                "name",
                "createdAt",
                "description"
              ],
              "type": "string"
            }
          },
          {
            "description": "Direction of the sorting (Ascending/Descending)",
            "in": "query",
            "name": "sortDirection",
            "required": false,
            "schema": {
              "default": "ASC",
              "enum": [
                "ASC",
                "DESC"
              ],
              "type": "string"
            }
          },
          {
            "description": "Search keyword",
            "in": "query",
            "name": "search",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Maximum number of user details per group",
            "in": "query",
            "name": "expandGroupUsersMaxCount",
            "required": false,
            "schema": {
              "default": 0,
              "maximum": 100,
              "minimum": 0,
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupListingResponse"
                }
              }
            },
            "description": "Successful operation"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get the brand membership groups",
        "tags": [
          "Brand Memberships"
        ]
      }
    }
  },
  "servers": [
    {
      "description": "US Production Server",
      "url": "https://api-us.streamline.intellistack.ai"
    },
    {
      "description": "Canada Production Server",
      "url": "https://api-ca.streamline.intellistack.ai"
    }
  ]
}
```