Get for administrator

import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        environment: ChrtEnvironment.Local,
        token: "YOUR_TOKEN_HERE",
    });
    await client.notifications.groups.getForAdministratorV1("group_id");
}
main();

{
  "schema_version": 1,
  "group_name": "Operations Team Notifications",
  "org_id": "org_9f8b7c6d5e4a3b2c1d0e",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "last_edited_at_timestamp": "2024-04-20T14:45:00Z",
  "_id": "group_0987654321fedcba",
  "user_ids": [
    "user_1234567890abcdef"
  ],
  "user_ids_opted_out": [
    "user_abcdef1234567890"
  ],
  "email_events": [
    "shipping.order.staged",
    "shipping.order.completed",
    "billing.statement.paid"
  ],
  "push_events": [
    "shipping.task_group.driver_assigned",
    "shipping.task.completed"
  ],
  "sms_events": [
    "shipping.order.cancelled"
  ]
}

Retrieves full notification group details including user membership. | authz: min_org_role=operator | () -> (NotificationGroup1)

Authentication

AuthorizationBearer

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

Path parameters

group_idstringRequired

Response

Successful Response

schema_versioninteger

group_namestring

org_idstring

Must be a string starting with org_

created_at_timestampstringformat: "date-time"

last_edited_at_timestampstringformat: "date-time"

_idstring

user_idslist of strings or null

user_ids_opted_outlist of strings or null

email_eventslist of enums or null

push_eventslist of enums or null

sms_eventslist of enums or null

Authentication

Path parameters

Response

Errors