Get the organization

GET

organization

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.organization.find();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "alerts": {
    "deliverability": true
  },
  "bouncePolicy": {
    "stopOnSoftFailure": true,
    "suppressOnSoftStop": true
  },
  "name": "Acme",
  "onboarding": {
    "completed": true,
    "completedAt": 1765432100000
  },
  "orgId": "org_2y8KqM4wXv1Z",
  "profile": {
    "industry": "B2B SaaS",
    "teamSize": "2-10",
    "website": "https://acme.com"
  },
  "tenantReady": true,
  "watchdog": {
    "enabled": true
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Response

The organization's current state: profile, onboarding, notification/watchdog settings, and whether provisioning is complete.

alerts

OrganizationAlerts · object

required

Notification preferences.

Show child attributes

bouncePolicy

OrganizationBouncePolicy · object

required

Bounce-handling policy for soft delivery failures.

Show child attributes

name

string

required

The organization display name.

Example:

"Acme"

onboarding

OrganizationOnboarding · object

required

Onboarding completion state.

Show child attributes

orgId

string

required

The organization id.

Example:

"org_2y8KqM4wXv1Z"

profile

OrganizationProfile · object

required

The company profile.

Show child attributes

tenantReady

boolean

required

Whether the organization is fully provisioned and active.

watchdog

OrganizationWatchdog · object

required

Deliverability watchdog settings.

Show child attributes

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.organization.find();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "alerts": {
    "deliverability": true
  },
  "bouncePolicy": {
    "stopOnSoftFailure": true,
    "suppressOnSoftStop": true
  },
  "name": "Acme",
  "onboarding": {
    "completed": true,
    "completedAt": 1765432100000
  },
  "orgId": "org_2y8KqM4wXv1Z",
  "profile": {
    "industry": "B2B SaaS",
    "teamSize": "2-10",
    "website": "https://acme.com"
  },
  "tenantReady": true,
  "watchdog": {
    "enabled": true
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Get the organization

Authorizations

Response