Get a group

GET 
/:customer_id/groups/:group_id

Get group details

Request

Path Parameters

customer_id Customer Idrequired

Id of the tenant

group_id Group Idrequired

Id of the group

Responses

200

application/json

Schema

Schema

description Description

Description of the group

user_settings object

Default value: [object Object]

Settings for the users in the group

group_settings object

Default value: [object Object]

Settings for the group

notification_emails string[]nullable

Default value: ``

Emails to notify for group alerts

notification_webhooks string[]nullable

Default value: ``

Webhooks to notify for group alerts

members object[]
List of members uids in the group
Array [
uid uuidrequired
User id
external_id External Idrequired
External id of the user
alias Aliasnullablerequired
Alias of the user
]

Example (from schema)

{
  "description": "string",
  "user_settings": {},
  "group_settings": {},
  "notification_emails": [
    "string"
  ],
  "notification_webhooks": [
    "string"
  ],
  "members": [
    {
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_id": "string",
      "alias": "string"
    }
  ]
}

400

Validation error

application/json

Schema

Schema

message Messagerequired
errors undefined[]nullablerequired

Example (from schema)

{
  "message": "string",
  "errors": [
    null
  ]
}

Loading...