Search for subscribers

GET/v2/subscribers

Authorization

Authorization<token>

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

In: header

Query Parameters

afterstring

Cursor for pagination indicating the starting point after which to fetch results.

beforestring

Cursor for pagination indicating the ending point before which to fetch results.

limitnumber

Limit the number of items to return

orderDirectionstring

Direction of sorting

Value in: "ASC" | "DESC"

orderBystring

Field to order by

includeCursorboolean

Include cursor item in response

emailstring

Email address of the subscriber to filter results.

namestring

Name of the subscriber to filter results.

phonestring

Phone number of the subscriber to filter results.

subscriberIdstring

Unique identifier of the subscriber to filter results.

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X GET "https://api.novu.co/v2/subscribers?after=%3Cstring%3E&before=%3Cstring%3E&limit=0&orderDirection=ASC&orderBy=%3Cstring%3E&includeCursor=true&email=%3Cstring%3E&name=%3Cstring%3E&phone=%3Cstring%3E&subscriberId=%3Cstring%3E" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>"

{
  "data": [
    {
      "_id": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "avatar": "string",
      "locale": "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",
      "__v": 0,
      "data": {},
      "timezone": "string",
      "subscriberId": "string",
      "_organizationId": "string",
      "_environmentId": "string",
      "deleted": true,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0,
  "totalCountCapped": true
}

Authorization

Query Parameters

Header Parameters

Response

TypeScript