GET
/
v1
/
subscribers
Get subscribers
curl --request GET \
  --url https://api.novu.co/v1/subscribers
{
  "page": 123,
  "hasMore": true,
  "pageSize": 123,
  "data": [
    {
      "_id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "avatar": "<string>",
      "locale": "<string>",
      "subscriberId": "<string>",
      "channels": [
        {
          "providerId": "slack",
          "integrationIdentifier": "<string>",
          "credentials": {
            "webhookUrl": "<string>",
            "channel": "<string>",
            "deviceTokens": [
              "<string>"
            ],
            "alertUid": "<string>",
            "title": "<string>",
            "imageUrl": "<string>",
            "state": "<string>",
            "externalUrl": "<string>"
          },
          "_integrationId": "<string>"
        }
      ],
      "isOnline": true,
      "lastOnlineAt": "<string>",
      "_organizationId": "<string>",
      "_environmentId": "<string>",
      "deleted": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "__v": 123
    }
  ]
}

Query Parameters

​
page
number
​
limit
number
default:10
Required range: x <= 100

Response

​
page
number
required

The current page of the paginated response

​
hasMore
boolean
required

Does the list have more items to fetch

​
pageSize
number
required

Number of items on each page

​
data
object[]
required

The list of items matching the query