Get subscribers

Returns a list of subscribers, could paginated using the `page` and `limit` query parameter

GET/v1/subscribers

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

In: header

Query Parameters

pagenumber

limitnumber

Default: 10Maximum: 100

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X GET "https://api.novu.co/v1/subscribers?page=0&limit=10" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>"

{
  "page": 0,
  "hasMore": true,
  "pageSize": 0,
  "data": [
    {
      "_id": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "avatar": "string",
      "locale": "string",
      "subscriberId": "string",
      "channels": [
        {
          "providerId": "slack",
          "integrationIdentifier": "string",
          "credentials": {
            "webhookUrl": "https://example.com/webhook",
            "channel": "general",
            "deviceTokens": [
              "token1",
              "token2",
              "token3"
            ],
            "alertUid": "12345-abcde",
            "title": "Critical Alert",
            "imageUrl": "https://example.com/image.png",
            "state": "resolved",
            "externalUrl": "https://example.com/details"
          },
          "_integrationId": "string"
        }
      ],
      "topics": [
        "string"
      ],
      "isOnline": true,
      "lastOnlineAt": "string",
      "_organizationId": "string",
      "_environmentId": "string",
      "deleted": true,
      "createdAt": "string",
      "updatedAt": "string",
      "__v": 0,
      "data": {},
      "timezone": "string"
    }
  ]
}

Authorization

Query Parameters

Header Parameters

Response

TypeScript