DocumentationDocumentation
DocumentationFrameworkCommunityAPI Reference
Sign InSign Up

GitHubnovuhq/novu

36.6K

Get subscriber

Get subscriber by your internal id used to identify the subscriber

GET/v2/subscribers/{subscriberId}
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
    • ,\ \\\,_ \` ,\ __,.-" =__) ." ),_/ , \/\_\_| )_-\ \_-` `-----` `--`
    __ // \,_ \` ,\ __,.-" =__) ." ),_/ , \/\ \_| // / / / / /
    Let's Get Started

    Create request, folder, collection or import from OpenAPI/Postman

    /v2/subscribers
    No authentication selected
    Key
    Value
    idempotency-key
    Value
    after
    Value
    before
    Value
    email
    Value
    name
    Value
    phone
    Value
    subscriberId
    Value
    limit
    Value
    orderDirection
    orderBy
    Value
    Response
    Scalar App V2.2.45 Beta
    Roadmap
    Powered By Scalar.com
    .,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:. ||||||||||||||!?TFPRBBBBBBBBBBBBBBB8m=, |||| '""^^!!||||||||||TFPRBBBVT!:...! |||| '""^^!!|||||?!:.......! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! ||||, ||||.........` |||||!!-._ ||||.......;. ':!|||||||||!!-._ ||||.....bBBBBWdou,. bBBBBB86foi!|||||||!!-..:|||!..bBBBBBBBBBBBBBBY! ::!?TFPRBBBBBB86foi!||||||||!!bBBBBBBBBBBBBBBY..! :::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....! :::;`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......! ;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........! .ob86foi;::::::::::::::::::::::::!?TFPRBY..........` .b888888888886foi;:::::::::::::::::::::::..........` .b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......`!Tf998888888888888888888888888888888886foi;:::....` '"^!|Tf9988888888888888888888888888888888!::..` '"^!|Tf998888888888888888888888889!! '` '"^!|Tf9988888888888888888!!` iBBbo. '"^!|Tf998888888889!` WBBBBbo. '"^!|Tf9989!` YBBBP^' '"^!` `

    Authorization

    Authorization<token>

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

    In: header

    Path Parameters

    subscriberIdRequiredstring

    Header Parameters

    idempotency-keystring

    A header for idempotency purposes

    curl -X GET "https://api.novu.co/v2/subscribers/<string>" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>"

    OK

    {
  "_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"
}

    Edit on GitHub

    Previous

    Delete subscriber DELETE

    Next

    Search for subscribers GET