GET
/
v1
/
subscribers
Authorization
Query
curl --request GET \
  --url https://api.novu.co/v1/subscribers \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "__v": "number",
      "_environmentId": "string",
      "_id": "string",
      "_organizationId": "string",
      "avatar": "string",
      "channels": [
        {
          "_integrationId": "string",
          "credentials": {
            "channel": "string",
            "deviceTokens": [
              "string"
            ],
            "webhookUrl": "string"
          },
          "integrationIdentifier": "string",
          "providerId": "slack"
        }
      ],
      "createdAt": "string",
      "deleted": "boolean",
      "email": "string",
      "firstName": "string",
      "isOnline": "boolean",
      "lastName": "string",
      "lastOnlineAt": "string",
      "locale": "string",
      "phone": "string",
      "subscriberId": "string",
      "updatedAt": "string"
    }
  ],
  "hasMore": "boolean",
  "page": "number",
  "pageSize": "number"
}

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorizationheaderrequired
string

Query Parameters

page
number
limit
Default: "10"
number

Response

200 - application/json
datarequired
object[]

The list of items matching the query

hasMorerequired
boolean

Does the list have more items to fetch

pagerequired
number

The current page of the paginated response

pageSizerequired
number

Number of items on each page

Was this page helpful?

Cancel triggered eventCreate subscriber