Contacts_getList_Response_200

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/brevo/main/json-schema/brevo-contacts-get-list-response-200-schema.json",
  "title": "Contacts_getList_Response_200",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/brevo-contacts-api-openapi.yml#/components/schemas/Contacts_getList_Response_200",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "ID of the list"
    },
    "name": {
      "type": "string",
      "description": "Name of the list"
    },
    "totalBlacklisted": {
      "type": "integer",
      "format": "int64",
      "description": "Number of blacklisted contacts in the list"
    },
    "totalSubscribers": {
      "type": "integer",
      "format": "int64",
      "description": "Number of contacts in the list"
    },
    "uniqueSubscribers": {
      "type": "integer",
      "format": "int64",
      "description": "Number of unique contacts in the list"
    },
    "campaignStats": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ContactsListsListIdGetResponsesContentApplicationJsonSchemaCampaignStatsItems"
      }
    },
    "createdAt": {
      "type": "string",
      "description": "Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ)"
    },
    "dynamicList": {
      "type": "boolean",
      "description": "Status telling if the list is dynamic or not (true=dynamic, false=not dynamic)"
    },
    "folderId": {
      "type": "integer",
      "format": "int64",
      "description": "ID of the folder"
    }
  },
  "required": [
    "id",
    "name",
    "totalBlacklisted",
    "totalSubscribers",
    "uniqueSubscribers",
    "createdAt",
    "folderId"
  ],
  "$defs": {
    "ContactsListsListIdGetResponsesContentApplicationJsonSchemaCampaignStatsItems": {
      "type": "object",
      "properties": {
        "campaignId": {
          "type": "integer",
          "format": "int64",
          "description": "ID of the campaign"
        },
        "stats": {
          "$ref": "#/$defs/getCampaignStats"
        }
      },
      "required": [
        "campaignId",
        "stats"
      ],
      "title": "ContactsListsListIdGetResponsesContentApplicationJsonSchemaCampaignStatsItems"
    },
    "getCampaignStats": {
      "type": "object",
      "properties": {
        "appleMppOpens": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Numbers of times your email has been opened automatically through Apple MPP."
        },
        "clickers": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of total clicks for the campaign"
        },
        "complaints": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of complaints (Spam reports) for the campaign"
        },
        "deferred": {
          "type": "integer",
          "format": "int64",
          "description": "Number of deferred emails for the campaign"
        },
        "delivered": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of delivered emails for the campaign"
        },
        "estimatedViews": {
          "type": "integer",
          "format": "int64",
          "description": "Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails"
        },
        "hardBounces": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of hard bounces for the campaign"
        },
        "listId": {
          "type": "integer",
          "format": "int64",
          "description": "List Id of email campaign (only in case of get email campaign(s)(not for global stats))"
        },
        "opensRate": {
          "type": [
            "string",
            "null"
          ],
          "title": "float",
          "description": "Percentage of recipients who open the email out of your total number of recipients. Depending on your Campaign settings, they may include Apple MPP opens."
        },
        "returnBounce": {
          "type": "integer",
          "format": "int64",
          "description": "Total number of non-delivered campaigns for a particular campaign id."
        },
        "sent": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of sent emails for the campaign"
        },
        "softBounces": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of softbounce for the campaign"
        },
        "trackableViews": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Recipients without any privacy protection option enabled in their email email client"
        },
        "trackableViewsRate": {
          "type": "string",
          "title": "float",
          "description": "Rate of recipients without any privacy protection option enabled in their email client"
        },
        "uniqueClicks": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of unique clicks for the campaign"
        },
        "uniqueViews": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of unique openings for the campaign"
        },
        "unsubscriptions": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of unsubscription for the campaign"
        },
        "viewed": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Number of openings for the campaign"
        }
      },
      "required": [
        "appleMppOpens",
        "clickers",
        "complaints",
        "delivered",
        "hardBounces",
        "opensRate",
        "sent",
        "softBounces",
        "trackableViews",
        "uniqueClicks",
        "uniqueViews",
        "unsubscriptions",
        "viewed"
      ],
      "title": "getCampaignStats"
    }
  }
}