import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.environments.getAll();
use Novu\SDK\Novu;
$novu = new Novu(<NOVU_API_KEY>);
$novu->getEnvironments()->toArray();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.environments()
from novu.api import EnvironmentApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = EnvironmentApi(url, api_key).list(
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.environments();
}
}
import co.novu.Novu
import co.novu.extensions.environments
fun main() {
val novu = Novu(apiKey = "API_KEY")
val environment = novu.environments()
println(environment)
}
curl --request GET \
--url https://api.novu.co/v1/environments \
--header 'Authorization: ApiKey <NOVU_API_KEY>'
{
"data": [
{
"_id": "string",
"name": "string",
"_organizationId": "string",
"identifier": "string",
"apiKeys": [
{
"key": "string",
"_userId": "string"
}
],
"_parentId": "string"
}
]
}
Environments
List all environments
This API returns a list of environments for the current organization. Each environment contains its configuration, API keys (if user has access), and metadata.
GET
/
v1
/
environments
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.environments.getAll();
use Novu\SDK\Novu;
$novu = new Novu(<NOVU_API_KEY>);
$novu->getEnvironments()->toArray();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.environments()
from novu.api import EnvironmentApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = EnvironmentApi(url, api_key).list(
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.environments();
}
}
import co.novu.Novu
import co.novu.extensions.environments
fun main() {
val novu = Novu(apiKey = "API_KEY")
val environment = novu.environments()
println(environment)
}
curl --request GET \
--url https://api.novu.co/v1/environments \
--header 'Authorization: ApiKey <NOVU_API_KEY>'
{
"data": [
{
"_id": "string",
"name": "string",
"_organizationId": "string",
"identifier": "string",
"apiKeys": [
{
"key": "string",
"_userId": "string"
}
],
"_parentId": "string"
}
]
}
Enter your API key in the
Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80eimport { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.environments.getAll();
use Novu\SDK\Novu;
$novu = new Novu(<NOVU_API_KEY>);
$novu->getEnvironments()->toArray();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.environments()
from novu.api import EnvironmentApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = EnvironmentApi(url, api_key).list(
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.environments();
}
}
import co.novu.Novu
import co.novu.extensions.environments
fun main() {
val novu = Novu(apiKey = "API_KEY")
val environment = novu.environments()
println(environment)
}
curl --request GET \
--url https://api.novu.co/v1/environments \
--header 'Authorization: ApiKey <NOVU_API_KEY>'
{
"data": [
{
"_id": "string",
"name": "string",
"_organizationId": "string",
"identifier": "string",
"apiKeys": [
{
"key": "string",
"_userId": "string"
}
],
"_parentId": "string"
}
]
}
Was this page helpful?
⌘I