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

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

async function run() {
  const result = await novu.tenants.list(7685.78, 10);

  for await (const page of result) {
    // handle page
  }
}

run();
{
  "page": 123,
  "hasMore": true,
  "pageSize": 123,
  "data": [
    {
      "_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>".

Query Parameters

​
page
number
​
limit
number
default:
10
Required range: x < 100

Response

200
application/json
​
page
number
required

The current page of the paginated response

​
hasMore
boolean
required

Does the list have more items to fetch

​
pageSize
number
required

Number of items on each page

​
data
object[]
required

The list of items matching the query

Was this page helpful?