TypeScript SDK

The SDK is generated automatically from the LineBundle OpenAPI spec on every release, so types and methods are always in sync with the latest API.

Requirements

Node.js 18+ (or any runtime with the native fetch API)
ESM project — the package is "type": "module". CommonJS projects can load it with a dynamic await import('@linebundle-sdk/ts').

Installation

npm install @linebundle-sdk/ts

pnpm add @linebundle-sdk/ts

yarn add @linebundle-sdk/ts

bun add @linebundle-sdk/ts

Authentication

The SDK authenticates using an API credential you generate directly inside the LineBundle Studio. No OAuth flows, no client secrets — just a token tied to your organization.

Get your API credential

Log in to LineBundle Studio
Open your organization → Settings → API Credentials
Click New Credential, give it a name, and copy the token (sk_lb_...)
Copy your Organization ID from the same settings page

The token is shown only once. Store it in your secrets manager or environment variables immediately.

Set environment variables

LINEBUNDLE_TOKEN=sk_lb_your_token_here
LINEBUNDLE_ORG_ID=your-org-uuid-here

Initialize the SDK

import { createLinebundle } from '@linebundle-sdk/ts';

const lb = createLinebundle({
  token: process.env.LINEBUNDLE_TOKEN!,
  orgId: process.env.LINEBUNDLE_ORG_ID!,
});

That’s it. The base URL defaults to https://api.linebundle.com — nothing else to configure.

Create lb once at module level and reuse it across your application. Each call to createLinebundle creates an isolated client instance scoped to those credentials.

Credential permissions

The credential inherits the permissions of the user who created it, scoped to the organization. If a request returns 403, check that the credential’s associated user has the appropriate role for the operation.

Environments

Environment	Base URL
Production	`https://api.linebundle.com` (default)
Staging	`https://staging-api.linebundle.com`

Staging and production credentials are separate — generate a credential in each environment’s Studio. To target staging, pass baseUrl:

const lb = createLinebundle({
  token: process.env.LINEBUNDLE_TOKEN!,
  orgId: process.env.LINEBUNDLE_ORG_ID!,
  baseUrl: 'https://staging-api.linebundle.com',
});

Quick Start

import { createLinebundle } from '@linebundle-sdk/ts';

const lb = createLinebundle({
  token: process.env.LINEBUNDLE_TOKEN!,
  orgId: process.env.LINEBUNDLE_ORG_ID!,
});

// List upcoming events
const { data, error } = await lb.events.list({
  query: { page: 1, size: 20, sort_by: 'start_dt', sort_dir: 'asc' },
});
if (error) throw error;
console.log(data.items);   // EventResponse[]
console.log(data.total);   // total matching records

// Get a single event
const { data: event, error: eventError, response } = await lb.events.get({
  path: { id: 123 },
});
if (eventError) {
  if (response.status === 404) console.warn('Event not found');
  else throw eventError;
}
console.log(event.title, event.start_dt);

// List spaces
const { data: spacesData } = await lb.spaces.list({
  query: { page: 1, size: 50, sort_by: 'title', sort_dir: 'asc' },
});
console.log(spacesData.items.map((s) => s.title));

Response Pattern

Every SDK method returns { data, error, response }. HTTP errors never throw — they are captured in error. Always check error before reading data.

const { data, error, response } = await lb.events.list({
  query: { page: 1, size: 10 },
});

if (error) {
  console.error(`HTTP ${response.status}`, error);
} else {
  console.log(data.items);   // current page of results
  console.log(data.total);   // total record count across all pages
  console.log(data.size);    // page size used in this request
}

Network-level failures (DNS, timeout, connection refused) still throw a regular Error. Wrap calls in try/catch if you need to handle both HTTP errors and network failures.

Error Handling

Use response.status to branch on specific HTTP status codes:

const { data, error, response } = await lb.events.get({
  path: { id: 123 },
});

if (error) {
  switch (response.status) {
    case 401:
      throw new Error('Invalid or expired token — check LINEBUNDLE_TOKEN');
    case 403:
      throw new Error('Access denied — check the credential permissions');
    case 404:
      console.warn('Event not found');
      break;
    case 429:
      console.warn('Rate limited — back off and retry');
      break;
    default:
      throw error;
  }
}

Parameters

Parameters are structured by their location in the HTTP request:

Location	Key	Example
URL path	`path`	`{ path: { id: 123 } }`
Query string	`query`	`{ query: { page: 1, size: 20 } }`
Request body	`body`	`{ body: { title: 'My Event' } }`

All parameter names are snake_case, matching the API exactly. Pagination uses page (1-based) and size. Sorting uses sort_by and sort_dir ('asc' / 'desc').

// List events — page 2, 20 per page, sorted ascending
const { data } = await lb.events.list({
  query: { page: 2, size: 20, sort_by: 'start_dt', sort_dir: 'asc' },
});

// Get event by ID
const { data } = await lb.events.get({ path: { id: 123 } });

// Create an event
const { data } = await lb.events.create({
  body: {
    title: 'Annual Conference',
    start_dt: '2026-09-01',
    start_tm: '09:00',
    end_dt: '2026-09-01',
    end_tm: '17:00',
    timezone: 'America/New_York',
  },
});

TypeScript Types

All request and response types are generated from the API schema and exported from the package:

import type { Event, Space } from '@linebundle-sdk/ts';

function processEvent(event: Event): void {
  console.log(event.title, event.start_dt, event.visibility);
}

Common Patterns

Paginate through all events

import type { Event } from '@linebundle-sdk/ts';

const PAGE_SIZE = 100;
let page = 1;
let totalPages = 1;
const allEvents: Event[] = [];

do {
  const { data, error } = await lb.events.list({
    query: { page, size: PAGE_SIZE, sort_by: 'start_dt', sort_dir: 'asc' },
  });
  if (error) throw error;

  allEvents.push(...(data.items ?? []));
  totalPages = Math.max(1, Math.ceil(data.total / data.size));
  page += 1;
} while (page <= totalPages);

Get spaces linked to an event

const { data: links, error } = await lb.events.listSpaces({
  path: { id: 123 },
  query: { page: 1, size: 100 },
});
if (error) throw error;
const spaceIds = (links.items ?? []).map((l) => l.space_id);

Scoped client for server functions

When running server-side (e.g. TanStack Start, Next.js Server Actions), create a new lb instance per request so concurrent calls don’t share state:

import { createLinebundle } from '@linebundle-sdk/ts';

async function withLinebundle<T>(run: (lb: ReturnType<typeof createLinebundle>) => Promise<T>): Promise<T> {
  const lb = createLinebundle({
    token: process.env.LINEBUNDLE_TOKEN!,
    orgId: process.env.LINEBUNDLE_ORG_ID,
  });
  return run(lb);
}

// Usage inside a server function
const { data } = await withLinebundle((lb) =>
  lb.events.list({ query: { page: 1, size: 20 } })
);

Browse the SDK Reference

The full method reference is auto-generated and available in the sidebar, grouped by resource:

Events

List, create, update, publish, archive, and version events

Spaces

Manage spaces, members, roles, and documents

Users & Orgs

Users, organizations, roles, and permissions

AI Agent

AI assistant sessions and cost tracking

Automation

Automation rules, triggers, cron jobs, and metadata

Messaging

Chat rooms, messages, and real-time channels

Analytics

Usage analytics and audit logs

Bookings

Event attendance, bookings, and waitlists

Contacts

Contact management within spaces

Integrations

Third-party integration connections

Getting Started

Events

Spaces

Users & Organizations

Automation

Bookings & Contacts

Analytics

Places

Utilities

Other

Requirements

Installation

Authentication

Get your API credential

Set environment variables

Initialize the SDK

Credential permissions

Environments

Quick Start

Response Pattern

Error Handling

Parameters

TypeScript Types

Common Patterns

Paginate through all events

Get spaces linked to an event

Scoped client for server functions

Browse the SDK Reference

Events

Spaces

Users & Orgs

AI Agent

Automation

Messaging

Analytics

Bookings

Contacts

Integrations

​Requirements

​Installation

​Authentication

​Get your API credential

​Set environment variables

​Initialize the SDK

​Credential permissions

​Environments

​Quick Start

​Response Pattern

​Error Handling

​Parameters

​TypeScript Types

​Common Patterns

​Paginate through all events

​Get spaces linked to an event

​Scoped client for server functions

​Browse the SDK Reference

Events

Spaces

Users & Orgs

AI Agent

Automation

Messaging

Analytics

Bookings

Contacts

Integrations

Requirements

Installation

Authentication

Get your API credential

Set environment variables

Initialize the SDK

Credential permissions

Environments

Quick Start

Response Pattern

Error Handling

Parameters

TypeScript Types

Common Patterns

Paginate through all events

Get spaces linked to an event

Scoped client for server functions

Browse the SDK Reference