Forms

List pending signups

Signups on a double opt-in form that have not clicked their confirmation link and have not expired, newest first. Each one carries the status of its confirmation email, the two-letter country it came from and the page it was submitted on, where known. Requires the form:read scope.

get/v1/forms/{id}/pending

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/forms/{id}/pending
  • Auth: HTTP bearer

Path parameters

idstring required

The signup form ID

Query parameters

pageinteger
per_pageinteger
qstring

Search by email, first name or last name

Response

A page of pending signups

objectstring required
has_moreboolean required
totalinteger required
undeliverable_totalinteger required

How many of the matching signups have an undeliverable confirmation email. Approve all leaves these out.

tor_totalinteger required

How many of the matching signups were submitted through Tor. Approve all leaves these out.

approvable_totalinteger required

How many of the matching signups Approve all would confirm.

pageinteger required
per_pageinteger required

Example response

{
  "object": "list",
  "data": [
    {
      "id": "clx_pending123",
      "email": "jane@example.com",
      "country": "US",
      "source_url": "https://example.com/blog/launch?utm_source=newsletter",
      "confirmation_email": {
        "id": "clx_email123",
        "status": "delivered"
      }
    }
  ],
  "total": 9,
  "undeliverable_total": 1,
  "tor_total": 2,
  "approvable_total": 6,
  "page": 1,
  "per_page": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.