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

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

async function run() {
  const result = await novu.organizations.list();

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

run();
[
  {
    "name": "<string>",
    "logo": "<string>",
    "branding": {
      "direction": "ltr",
      "logo": "<string>",
      "color": "<string>",
      "fontColor": "<string>",
      "contentBackground": "<string>",
      "fontFamily": "<string>"
    },
    "partnerConfigurations": [
      {
        "projectIds": [
          "<string>"
        ],
        "accessToken": "<string>",
        "configurationId": "<string>",
        "teamId": "<string>",
        "partnerType": "vercel"
      }
    ]
  }
]

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>".

Response

200
application/json

Ok

The response is of type object[].