List groups

GET

groups

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

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

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

{
  "data": [
    {
      "color": "rose",
      "description": "Leads captured at the June webinar.",
      "id": "grp_tz4a98xat96iws9zmbrgj3a",
      "memberCount": 248,
      "name": "Event attendees — June",
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "object": "group",
      "updatedAt": "<unknown>"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "total": 12,
  "object": "list"
}

{
  "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_….

Query Parameters

cursor

string

Opaque cursor from a previous page's nextCursor — returns results strictly after it. Example: "con_x7q2m9k4w8r1"

includeArchived

boolean

Include archived rows in the results (hidden by default). Example: true

limit

integer

Page size, 1-100. Defaults to 50. Example: 25

Required range: 1 <= x <= 100

string

Free-text search over the group name.

Example:

"vip"

Response

data

Group · object[]

required

The page of results, newest first.

Show child attributes

hasMore

boolean

required

Whether another page exists beyond this one.

nextCursor

string | null

required

Pass as cursor to fetch the next page; null when this is the last page.

total

integer

required

Total number of groups matching the search.

Required range: x >= 0

Example:

12

object

any

default:list

Always "list", marking this response as a collection.

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

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

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

{
  "data": [
    {
      "color": "rose",
      "description": "Leads captured at the June webinar.",
      "id": "grp_tz4a98xat96iws9zmbrgj3a",
      "memberCount": 248,
      "name": "Event attendees — June",
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "object": "group",
      "updatedAt": "<unknown>"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "total": 12,
  "object": "list"
}

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

Authorizations

Query Parameters

Response