List tier groups | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.tier.getListOfTierGroups("pid", {});
}
main();

{
  "items": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "downgradeStrategy": "real_time",
      "id": "string",
      "loyaltyProgramId": "string",
      "name": "string",
      "tierOrder": [],
      "updatedAt": "2024-01-15T09:30:00Z",
      "upgradeStrategy": "real_time",
      "upgradeSchedule": {
        "strategy": "string",
        "durationValue": 1,
        "durationUnit": "day",
        "durationModifier": "start_of_period",
        "scheduledDate": "string"
      },
      "downgradeSchedule": {
        "strategy": "string",
        "durationValue": 1,
        "durationUnit": "day",
        "durationModifier": "start_of_period",
        "scheduledDate": "string"
      }
    }
  ]
}

Returns the list of tier groups defined within the loyalty program.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"

Loyalty Program ID

Query parameters

versionenumOptionalDefaults to draft

Select 'active' to retrieve list of all tier groups which are live for clients. Select draft to retrieve list of all non deleted tier groups.

Allowed values:

Response

Tier group list successfully retrieved

itemslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.tier.getListOfTierGroups("pid", {});
8	}
9	main();

1	{
2	"items": [
3	{
4	"createdAt": "2024-01-15T09:30:00Z",
5	"downgradeStrategy": "real_time",
6	"id": "string",
7	"loyaltyProgramId": "string",
8	"name": "string",
9	"tierOrder": [],
10	"updatedAt": "2024-01-15T09:30:00Z",
11	"upgradeStrategy": "real_time",
12	"upgradeSchedule": {
13	"strategy": "string",
14	"durationValue": 1,
15	"durationUnit": "day",
16	"durationModifier": "start_of_period",
17	"scheduledDate": "string"
18	},
19	"downgradeSchedule": {
20	"strategy": "string",
21	"durationValue": 1,
22	"durationUnit": "day",
23	"durationModifier": "start_of_period",
24	"scheduledDate": "string"
25	}
26	}
27	]
28	}