Skip to main content
GET
/
v1
/
subscribers
List Subscribers
curl --request GET \
  --url https://api.migma.ai/v1/subscribers \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "email": "[email protected]",
      "firstName": "<string>",
      "lastName": "<string>",
      "country": "<string>",
      "language": "<string>",
      "tags": [
        "<string>"
      ],
      "customFields": {},
      "status": "active",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "error": "<string>",
  "count": 123
}

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Use 'Authorization: Bearer ' where the JWT token is obtained from the login endpoint.

Query Parameters

projectId
string
required

Project ID

page
integer
default:1

Page number for pagination

limit
integer
default:20

Number of results per page (max 100)

Required range: x <= 100
tags
string

Comma-separated tag names

status
enum<string>

Filter by subscriber status

Available options:
active,
unsubscribed,
bounced,
complained

Search query to filter subscribers

Response

Subscribers list

success
boolean
required
data
object[]
error
string | null
count
integer