List subscribers
GET/api/v1/subscribers
Your audience, with server-side filtering on score, temperature, tag, magnet, status, and search.
subscribers:readRead subscribers, their scores, tags, and engagement.
Notes
lead_score and temperature come from the same scoring used across the app, so a lead that is hot here is hot on your dashboard.total_matching is the size of the full filtered set, not the size of this page.A subscriber who found you through two different accounts is one person, but you only ever see your own relationship with them: your magnets, your requests, your engagement.
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
limit |
query | integer | 50 |
Rows to return, 1 to 200. |
offset |
query | integer | 0 |
Rows to skip, for paging. |
temperature |
query | string | Filter by lead temperature. One of: hot, warm, cool, cold. |
|
min_score |
query | integer | 0 |
Only leads scoring at least this, 0 to 100. |
tag |
query | string | Only leads carrying this tag. | |
magnet_id |
query | string | Only leads who requested this magnet. | |
status |
query | string | all |
Subscription state. One of: all, active, unsubscribed. |
search |
query | string | Matches email, first name, or last name. | |
created_after |
query | string | ISO 8601 timestamp, first seen on or after. | |
created_before |
query | string | ISO 8601 timestamp, first seen on or before. | |
order |
query | string | score |
Sort order. One of: score, recent, activity. |
Example
curl "https://resources.ashwanth.dev/api/v1/subscribers" \
-H "Authorization: Bearer $LEADMAGNET_API_KEY"
Try it
API key
Held in this page only, never saved or sent anywhere but this API. If you are signed in, you can leave it blank.
Parameters
limitoffsettemperaturemin_scoretagmagnet_idstatussearchcreated_aftercreated_beforeorderRequest
GET /api/v1/subscribers