Skip to main content
GET
/
v1
/
environments
import { Novu } from '@novu/node';

const novu = new Novu('<NOVU_API_KEY>');

await novu.environments.getAll();

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "_organizationId": "string",
      "identifier": "string",
      "apiKeys": [
        {
          "key": "string",
          "_userId": "string"
        }
      ],
      "_parentId": "string"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://v0.x-docs.novu.co/llms.txt

Use this file to discover all available pages before exploring further.

Enter your API key in the Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80e
import { Novu } from '@novu/node';

const novu = new Novu('<NOVU_API_KEY>');

await novu.environments.getAll();

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "_organizationId": "string",
      "identifier": "string",
      "apiKeys": [
        {
          "key": "string",
          "_userId": "string"
        }
      ],
      "_parentId": "string"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Response

Ok

​
name
string
required
​
_organizationId
string
required
​
identifier
string
required
​
_parentId
string
required
​
_id
string
​
apiKeys
object[]