RecipientGroupResponseDto

Endpoints · All schemas

Field	Required	Description
createdAt	Yes	When the group was saved
id	Yes	Recipient group ID
name	Yes	Name, visible to its owner only
updatedAt	Yes	When the group last changed
users	Yes	People in the group who still have an account, by name

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: UserResponseDto

{
  "properties": {
    "createdAt": {
      "description": "When the group was saved",
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "description": "Recipient group ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "name": {
      "description": "Name, visible to its owner only",
      "type": "string"
    },
    "updatedAt": {
      "description": "When the group last changed",
      "format": "date-time",
      "type": "string"
    },
    "users": {
      "description": "People in the group who still have an account, by name",
      "items": {
        "$ref": "#/components/schemas/UserResponseDto"
      },
      "type": "array"
    }
  },
  "required": [
    "createdAt",
    "id",
    "name",
    "updatedAt",
    "users"
  ],
  "type": "object"
}