Retrieve all suppression groups associated with the user.

v1.0.0

This endpoint allows you to retrieve a list of all suppression groups created by this user.

This endpoint can also return information for multiple group IDs that you include in your request. To add a group ID to your request, simply append ?id=123456&id=123456, with the appropriate group IDs.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "on-behalf-of": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "name",
      "description"
    ],
    "properties": {
      "description": {
        "type": "string",
        "description": "A description of the suppression group."
      },
      "id": {
        "type": "number",
        "description": "The id of the suppression group."
      },
      "is_default": {
        "type": "boolean",
        "description": "Indicates if this is the default suppression group."
      },
      "last_email_sent_at": {
        "type": "object"
      },
      "name": {
        "type": "string",
        "description": "The name of the suppression group. Each group created by a user must have a unique name."
      },
      "unsubscribes": {
        "type": "integer",
        "description": "The unsubscribes associated with this group."
      }
    }
  }
}