Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

GET/api/v1/projects/{project_id}/lists/{list_id}/subscribers/by-email/{email}

Needs scope: readMCP tool: find_subscriber operationId find_subscriber

Find a subscriber by email

The subscriber of this address on the list; the address is normalized, so any case or surrounding whitespace finds it. Needs scope read.

Parameters

NameInTypeDescription
project_idrequired path string · uuid The project’s id
list_idrequired path string · uuid The list’s id
emailrequired path string · email The subscriber’s address

Request body

None.

Responses

200

The subscriber

  • Subscriber object · all fields required
  • attributesobject

    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

    example ann@example.com

  • idstring · uuid

    example 01900000-0000-7000-8000-000000000001

  • list_idstring · uuid

    The list the subscriber is on.

  • project_idstring · uuid

    The subscriber’s project.

  • soft_bounce_streakinteger · int32

    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.

    example active

  • unsubscribed_atstring · date-time | null

    When the subscriber unsubscribed; null otherwise.

  • updated_atstring · date-time

    The latest change: creation, an attribute merge, a status change.

403

A project key without scope read (forbidden)

Problem (application/problem+json)

404

No such subscriber, list or project, or another project’s (not_found)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

HeaderTypeDescription
Retry-AfterintegerSeconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)