`find_subscriber`

Finds a subscriber by its email on a list.

Call it: to look up a subscriber when you know its address, in any case or with surrounding whitespace.
Needs: the list’s id, the email, and an admin key with project_id, or a project key with scope read (its own project; the argument is ignored).
Returns: the subscriber, the same as GET /api/v1/projects/{project_id}/lists/{list_id}/subscribers/by-email/{email}; not_found when the list has no such address.

Arguments

object
emailstringrequired

The address; any case and surrounding whitespace are normalized.

example ann@example.com
list_idstring · uuidrequired

The list to look on.
project_idstring · uuid | null

The subscriber’s project. An admin key must pass it; a project key’s own project is used and this is ignored.

No other arguments are accepted.

The result comes back as structuredContent, with the same JSON as a text block.

object · all fields required
attributesmap of string → string | number | boolean

The subscriber’s attributes: a map of string, number or boolean values.
confirmed_atstring · date-time | null

When the subscriber confirmed a double opt-in; null otherwise.
created_atstring · date-time
emailstring · email
idstring · uuid
list_idstring · uuid

The list the subscriber is on.
project_idstring · uuid

The subscriber’s project.
soft_bounce_streakinteger · uint32

Soft bounces in a row; reset by a delivery (P4+).

≥ 0
sourcestring

How the subscriber was added: api, import or confirm.
statusstring

pending, active, unsubscribed, bounced or complained.
unsubscribed_atstring · date-time | null

When the subscriber unsubscribed; null otherwise.
updated_atstring · date-time

The latest change: creation, an attribute merge.

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors