List by org

GET

/notifications/groups/list_by_org/v1

GET

/notifications/groups/list_by_org/v1

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

1 {
2   "items": [
3     {
4       "_id": "group_9f8b7c6d5e4a3b2c1d0e",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "group_name": "Operations Team Notifications",
7       "last_edited_at_timestamp": "2024-04-10T14:45:00Z",
8       "org_id": "org_1234567890abcdef",
9       "schema_version": 1,
10       "email_events": [
11         "shipping.order.staged",
12         "shipping.task.completed",
13         "billing.statement.paid"
14       ],
15       "push_events": [
16         "shipping.task_group.in_progress",
17         "operations.case.message"
18       ],
19       "sms_events": [
20         "shipping.order.cancelled",
21         "shipping.task.attempted"
22       ],
23       "user_ids": [
24         "user_9876543210fedcba",
25         "user_1234567890abcdef"
26       ],
27       "user_ids_opted_out": [
28         "user_1122334455667788"
29       ]
30     }
31   ],
32   "total_count": 1
33 }

Lists all notification groups for the caller’s organization. | authz: min_org_role=operator | () -> (NotificationGroupListRes)

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Groups List by Org V1request Unprocessable Entity Error