Lumail.ioLumail.io
DocsBlogChangelog

Getting Started

  • Introduction
  • Tutorials
  • API Reference
  • Integrations
  • Features
  • Workflows

Tutorials

  • Create an API Token
  • Build a V0 Capture Page
  • Dynamic Promo Codes with Webhooks

API Reference

  • API Tokens
  • Rate Limits
  • POSTSend Transactional Email
  • POSTEmail Verification API
  • POSTCreate Subscriber
  • GETGet Subscriber
  • PATCHUpdate Subscriber
  • DELETEDelete Subscriber
  • POSTAdd Tags to Subscriber
  • DELETERemove Tags from Subscriber
  • POSTTrack Event
  • GETGet Subscriber Events
  • GETGet All Tags
  • POSTCreate a Tag
  • Send Email in HTML
  • Send Email in Markdown
  • Send Email in Tiptap

Integrations

  • ClickFunnels Integration
  • SystemIO Integration

Features

  • Variables
  • Subscriber Events
  • Revenue Tracking
  • Email Deliverability Score
  • Email Engagement Score
  • Content Deliverability Checker

Workflows

  • Wait Step
  • Email Step
  • Action Step
  • Webhook Step

domains

  • Email Domains
  • Web Domains

Get Subscriber

Retrieve a specific subscriber from your Lumail account

https://lumail.io/api/v1/subscribers/{subscriber}

Retrieves a specific subscriber by ID or email address with their associated tags and custom fields.

Response

  • Success (200 OK) - Returns the subscriber object with their data.
  • Error (404 Not Found) - Returned if the subscriber does not exist.

Response Fields

FieldTypeDescription
successbooleanIndicates if the operation was successful
subscriberobjectThe subscriber object with all its properties
subscriber.idstringUnique identifier for the subscriber
subscriber.emailstringEmail address of the subscriber
subscriber.namestring or nullName of the subscriber (if provided)
subscriber.phonestring or nullPhone number of the subscriber (if provided)
subscriber.statusstringCurrent status of the subscriber (e.g., "SUBSCRIBED", "UNSUBSCRIBED")
subscriber.tagsarrayArray of tag objects associated with the subscriber
subscriber.tags[].idstringUnique identifier for the tag
subscriber.tags[].namestringName of the tag
subscriber.fieldsobjectCustom field values associated with this subscriber

Request Schema

No request body is required for this endpoint. Use either the subscriber's unique ID or email address in the URL path.

Usage Example

Use this API endpoint to retrieve detailed information about a specific subscriber, which can help you:

  • Display subscriber profile information in your application
  • Check a subscriber's current subscription status
  • View which tags have been assigned to a subscriber
  • Access custom field values for personalization
  • Verify subscriber information before making updates
Create SubscriberUpdate Subscriber

Method

GET

Endpoint

/api/v1/subscribers/{subscriber}

Request Examples

curl -X GET https://lumail.io/api/v1/subscribers/sub_TTYPR5tWDh \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

# Or using email
curl -X GET https://lumail.io/api/v1/subscribers/subscriber@example.com \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response Examples

{
  "success": true,
  "subscriber": {
    "id": "sub_TTYPR5tWDh",
    "email": "subscriber@example.com",
    "name": "John Doe",
    "phone": "+1234567890",
    "status": "SUBSCRIBED",
    "tags": [
      {
        "id": "tag_JqaddtEx7z",
        "name": "newsletter"
      },
      {
        "id": "tag_rdEPhyjnfA",
        "name": "promotional"
      }
    ],
    "fields": {
      "city": "New York",
      "company": "Acme Inc"
    }
  }
}

On This Page

ResponseResponse FieldsRequest SchemaUsage Example

Lumail.io

Create and send e-mail without paying thousands of dollars

Product

BlogDocumentationChangelogDashboard

Company

AboutAccount

Legal

TermsPrivacy

8 The Green STE B, Dover Delaware 19901, United States

© 2025 Codelynx, LLC. All rights reserved.

Sign in