API Data Provider - Online Help

Subscribers

List all Subscribers of your account

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A read-only Drip generated unique id used to identify each subscriber record.

AccountId String False

Accounts.Id

The account Id.

Status String False

The subscriber's status whether active or unsubscribed.Filter by one of the following statuses: active, unsubscribed. Defaults to active.

The allowed values are active, unsubscribed, all.

Email String False

The subscriber's email address.

EuConsent String False

A string describing whether the subscriber GDPR consent is granted, denied, or unknown.

TimeZone String False

The subscriber's time zone (in Olson format).

UtcOffset Integer True

The UTC offset in minutes relative to UTC/GMT.

VisitorUuid String False

A read-only Drip generated unique id used to identify each subscriber's visitor record if available.

CustomFields String False

An Object containing custom field data

Tags String False

An Array containing one or more tags.

IpAddress String False

The subscriber's IP address if available.

UserAgent String True

The subscriber's browser User Agent if available.

OriginalReferrer String True

The initial referral URL when the subscriber first visited your site if available.

LandingUrl String True

The first page visited by the subscriber if available.

Prospect Boolean False

Returns true if the subscriber is marked as a lead.

LeadScore Integer True

The subscriber's lead score.

LifetimeValue Integer False

The subscriber's lifetime value in cents.

CreatedAt Datetime True

A timestamp representing when the subscriber record was first created.

Href String True

The url designated for retrieving the subscriber record via the REST API.

UserId Integer False

A unique identifier for the user in your database, such as a primary key.

BaseLeadScore Integer False

An Integer specifying the starting value for lead score calculation for this subscriber. Defaults to 30.

Links String True

An object containing the REST API URL for the account.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0