List by user

GET

/notifications/groups/list_by_user/v1

GET

/notifications/groups/list_by_user/v1

1 import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         environment: ChrtEnvironment.Local,
6         token: "YOUR_TOKEN_HERE",
7     });
8     await client.notifications.groups.listByUserV1();
9 }
10 main();

Try it

200Retrieved

1 [
2   {
3     "_id": "grp_9f8b7c6d5e4a3b2c1d0e",
4     "schema_version": 1,
5     "org_id": "org_12345abcde",
6     "group_name": "Warehouse Operations Team",
7     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
8     "email_events": [
9       "shipping.order.staged",
10       "shipping.task.completed",
11       "billing.statement.paid"
12     ],
13     "push_events": [
14       "shipping.order.staged",
15       "shipping.task_group.driver_assigned",
16       "billing.line_item_group.message"
17     ],
18     "sms_events": [
19       "shipping.order.staged",
20       "shipping.task.skipped"
21     ],
22     "is_opted_out": true
23   }
24 ]

Lists notification groups the caller is a member of. | () -> (list[NotificationGroupLimitedForDriver1])

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response

_idstring

schema_versioninteger

org_idstring

Must be a string starting with org_

group_namestring

last_edited_at_timestampstringformat: "date-time"

email_eventslist of enums

push_eventslist of enums

sms_eventslist of enums

is_opted_outboolean