GET
/
v1
/
tenants
/
{identifier}
import { Novu } from "@novu/api";

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.tenants.retrieve("<value>");

  // Handle the result
  console.log(result)
}

run();
{
  "_id": "<string>",
  "identifier": "<string>",
  "name": "<string>",
  "data": {},
  "_environmentId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
identifier
string
required

Response

200
application/json
Ok
​
_id
string
required
​
identifier
string
required
​
_environmentId
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
name
string
​
data
object

Was this page helpful?