Skip to main content

ContactListResponse

data object[]required
  • Array [
  • idstringrequired

    Unique contact identifier.

    emailstring<email>required

    Contact email address.

    namestring

    Contact display name.

    statusstringrequired

    Subscription status (read-only, computed by the system).

    Possible values: [subscribed, unsubscribed, cleaned]

    sourcestringrequired

    How the contact was created (read-only).

    Possible values: [api, bulk_api, csv_import, smtp, form, unknown]

    engagement_tierstringrequired

    Engagement tier based on email activity (read-only, computed by the system).

    Possible values: [no_data, new, engaged, at_risk, inactive, cold]

    tags object[]required

    Tags assigned to this contact.

  • Array [
  • idstringrequired

    Unique tag identifier.

    namestringrequired

    Tag name.

    colorstringnullable

    Tag color as hex string (e.g., "#3B82F6").

    created_atstring<date-time>required

    When the tag was created.

    updated_atstring<date-time>required

    When the tag was last updated.

  • ]
  • campaigns_received_countinteger

    Number of campaigns this contact has received (read-only).

    last_activity_atstring<date-time>nullable

    Last activity timestamp (read-only).

    created_atstring<date-time>required

    When the contact was created.

    updated_atstring<date-time>required

    When the contact was last updated.

  • ]
  • has_morebooleanrequired

    Whether there are more items available after this page.

    next_cursorstring

    Cursor to use as starting_after for the next page.

    ContactListResponse
    {
    "data": [
    {
    "id": "string",
    "email": "[email protected]",
    "name": "string",
    "status": "subscribed",
    "source": "api",
    "engagement_tier": "no_data",
    "tags": [
    {
    "id": "string",
    "name": "string",
    "color": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    ],
    "campaigns_received_count": 0,
    "last_activity_at": "2024-07-29T15:51:28.071Z",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    ],
    "has_more": true,
    "next_cursor": "string"
    }