Skip to content Skip to navigation Skip to topbar

List Trait Groups

(information)

Legal information

Conversation Memory, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum. For more details on AI usage and data, see the AI Nutrition Facts.

Conversation Memory is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversation Memory is not intended for use with sensitive information about individuals. Twilio does not control what information comes from conversation channels and relies on you to ensure the data in customer profiles aligns with our acceptable use policy. Twilio does have limited guardrails in the form of a prompt exclusion that is designed to provide a minimal screening against inclusion of GDPR special category data. As a reminder our profile technology uses generative artificial intelligence. Because generative artificial intelligence can make mistakes, review all outputs to ensure that the profile is correct.

Conversations products are only available in the new Twilio Console. If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

GET/v1/ControlPlane/Stores/{storeId}/TraitGroups

Base url: https://memory.twilio.com (base url)

Returns a list of Trait Groups for this Memory Store, with optional traits information.

Request

Authentication

Basic Auth

Path parameters

Property nameTypeRequiredPIIDescription

storeIdstring

required

A unique Memory Store ID using Twilio Type ID (TTID) format

Example: mem_store_00000000000000000000000000Pattern: ^mem_(store|service)_[0-7][0-9a-z]{25}$

Query string

Property nameTypeRequiredPIIDescription

includeTraitsboolean

Optional

Whether to include trait definitions in the response

Default: false

pageSizeinteger

Optional

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

Default: 50Minimum: 1Maximum: 100

pageTokenstring

Optional

The token for the page of results to retrieve.

Max length: 500

orderByenum<string>

Optional

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

Default: DESCPossible values:

ASCDESC

Responses

200400404429500503

List of TraitGroups retrieved successfully

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

traitGroupsarray[object]

Optional

Max items: 50

Show traitGroups properties

Property nameTypeRequiredPIIDescriptionChild properties

displayNamestring

Optional

Provides a unique and addressable name to be assigned to this Trait Group

Example: ContactPattern: ^[a-zA-Z0-9_\-\.]+$Min length: 1Max length: 64

descriptionstring

Optional

description of the Trait Group

Example: This Trait Group contains traits related to contact information.Max length: 1024

traitsobject

Optional

Map of traits that are part of this Trait Group, where the key is the trait name and the value is the trait's definition.

Example:

{"email":{"dataType":"STRING","description":"User's email address"},"dob":{"dataType":"STRING","description":"User's date of birth"}}

Max properties: 95

Show traits properties

versioninteger

Optional

The current version number of the Trait Group. Incremented on each successful update.

Example: 3Minimum: 1

metaobject

Optional

Show meta properties

Bad Request

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Not Found

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

This error indicates that you have sent too many requests to the API. You should retry according to the Retry-After response header.

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Internal Server Error

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Service Unavailable

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

List Trait Groups

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listTraitGroups() {
11  const traitGroups = await client.memory.v1
12    .traitGroups("mem_store_00000000000000000000000000")
13    .list({
14      orderBy: "DESC",
15      limit: 20,
16    });
17
18  traitGroups.forEach((t) => console.log(t.displayName));
19}
20
21listTraitGroups();

Response

1{
2  "meta": {
3    "key": "key",
4    "pageSize": 50,
5    "nextToken": "nextToken",
6    "previousToken": "previousToken"
7  },
8  "traitGroups": [
9    {
10      "displayName": "Contact",
11      "description": "description",
12      "traits": {},
13      "version": 3
14    }
15  ]
16}