Skip to main content
GET
/
email
/
contacts
/
unsubscribes
Get unsubscribed email contacts
curl --request GET \
  --url http://localhost/public/v1/email/contacts/unsubscribes
{
  "ok": true,
  "contacts": [
    {
      "id": "<string>",
      "team_id": "<string>",
      "email": "<string>",
      "status": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "is_email_valid": "<string>",
      "validation_method": "<string>",
      "validation_reason": "<string>",
      "validated_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "unsubscribed_at": "<string>",
      "unsubscribed_reason": "<string>",
      "first_sent_at": "<string>",
      "last_sent_at": "<string>",
      "sent_count": "<string>",
      "first_opened_at": "<string>",
      "last_opened_at": "<string>",
      "opens_count": "<string>",
      "first_clicked_at": "<string>",
      "last_clicked_at": "<string>",
      "clicks_count": "<string>",
      "first_lead_at": "<string>",
      "last_lead_at": "<string>",
      "leads_count": "<string>",
      "first_sale_at": "<string>",
      "last_sale_at": "<string>",
      "sales_count": "<string>",
      "first_bounced_at": "<string>",
      "last_bounced_at": "<string>",
      "hard_bounces_count": "<string>",
      "soft_bounces_count": "<string>",
      "custom_str_1": "<string>",
      "custom_str_2": "<string>",
      "custom_str_3": "<string>",
      "custom_str_4": "<string>",
      "custom_str_5": "<string>",
      "custom_int_1": "<string>",
      "custom_int_2": "<string>",
      "custom_int_3": "<string>",
      "custom_int_4": "<string>",
      "custom_int_5": "<string>",
      "custom_dec_1": "<string>",
      "custom_dec_2": "<string>",
      "custom_dec_3": "<string>",
      "custom_datetime_1": "<string>",
      "custom_datetime_2": "<string>",
      "custom_datetime_3": "<string>",
      "custom_bool_1": "<string>",
      "custom_bool_2": "<string>",
      "custom_bool_3": "<string>",
      "country_code": "<string>"
    }
  ],
  "meta": {
    "current_page": "<string>",
    "per_page": 123,
    "total": "<string>"
  }
}

Query Parameters

page
integer

Optional. Page number for pagination (default: 1).

Required range: x >= 1
per_page
integer

Optional. Number of items per page (default: 50, max: 100).

Required range: 1 <= x <= 100
search
string | null

Optional. Search term to filter by email address.

Maximum string length: 255

Response

ok
boolean
required
contacts
EmailContactResource · object[]
required
meta
object
required