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
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the operation was successful |
subscriber | object | The subscriber object with all its properties |
subscriber.id | string | Unique identifier for the subscriber |
subscriber.email | string | Email address of the subscriber |
subscriber.name | string or null | Name of the subscriber (if provided) |
subscriber.phone | string or null | Phone number of the subscriber (if provided) |
subscriber.status | string | Current status of the subscriber (e.g., "SUBSCRIBED", "UNSUBSCRIBED") |
subscriber.tags | array | Array of tag objects associated with the subscriber |
subscriber.tags[].id | string | Unique identifier for the tag |
subscriber.tags[].name | string | Name of the tag |
subscriber.fields | object | Custom 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