v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB
TraitGroup

Retrieve a Trait Group

Retrieve a specific Trait Group by its unique name for this Memory Store, with optional traits information.

get/v1/ControlPlane/Stores/{storeId}/TraitGroups/{traitGroupName}

Query parameters

includeTraitsboolean

Whether to include trait definitions in the response

pageSizeinteger

The maximum number of items to return per page, maximum of 100.

pageTokenstring

The token for the page of results to retrieve.

orderBy'ASC' | 'DESC'

Either 'ASC' or 'DESC' to sort results ascending or descending respectively.

Response

TraitGroup retrieved successfully

Example response

{
  "traitGroup": {
    "displayName": "Contact",
    "description": "This Trait Group contains traits related to contact information.",
    "traits": {
      "email": {
        "dataType": "STRING",
        "description": "User's email address"
      },
      "dob": {
        "dataType": "STRING",
        "description": "User's date of birth"
      }
    },
    "version": 3
  },
  "meta": {
    "nextToken": "eyJlYXN0ZXIiOiJlZ2cifQ",
    "previousToken": "eyJlYXN0ZXIiOiJlZ2cifQ"
  }
}