Raw schema
{
"type": "object",
"properties": {
"email_address": {
"description": "Only subscribers whose e-mail address contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 254
},
"type": {
"description": "Only subscribers of these types (e.g. regular, unactivated, unsubscribed).",
"minItems": 1,
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"enum": [
"blocked",
"complained",
"churning",
"churned",
"gifted",
"unactivated",
"unpaid",
"undeliverable",
"premium",
"past_due",
"paused",
"regular",
"removed",
"trialed",
"unsubscribed",
"upcoming"
]
}
},
"not_type": {
"description": "Exclude subscribers of these types.",
"minItems": 1,
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"enum": [
"blocked",
"complained",
"churning",
"churned",
"gifted",
"unactivated",
"unpaid",
"undeliverable",
"premium",
"past_due",
"paused",
"regular",
"removed",
"trialed",
"unsubscribed",
"upcoming"
]
}
},
"tag": {
"description": "Only subscribers with these tag names.",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"domain": {
"description": "Only subscribers whose e-mail domain is one of these.",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
}
},
"created_after": {
"description": "Only subscribers created on or after this date (yyyy-mm-dd).",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"created_before": {
"description": "Only subscribers created before this date (yyyy-mm-dd).",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"ordering": {
"description": "Sort field, - for descending (default -creation_date).",
"type": "string",
"pattern": "^-?[a-z_]{1,40}$"
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}