Lumen CoDocs
Dashboard

Disaster response

We have helped more than two hundred thousand people since we started. We measure success by how many donors come back and tell their friends.

11 min read Updated May 19, 2026 v4.0.1

Overview

A school kit costs less than a cinema ticket and lasts a whole year. We keep things simple, so you can focus on what matters to you. Monthly gifts let us plan ahead and respond quickly when disaster strikes.

Installation

Install the SDK with the package manager your project already uses. It needs Node 18 or newer.

terminal
$ npm install @lumen-co/sdk
terminal
$ yarn add @lumen-co/sdk
terminal
$ pnpm add @lumen-co/sdk
Using a server without Node? The same endpoints are available over plain HTTPS; see the API reference below.

Configuration

Our annual report is independently audited and published in full. We have helped more than two hundred thousand people since we started. Create a file named lumen-co.config.json in the project root:

lumen-co.config.json
{
  "project": "lumen-co",
  "region": "us-east",
  "categories": ["education", "health", "environment"],
  "retries": 4,
  "timeoutMs": 11000,
  "webhooks": { "enabled": true }
}
OptionTypeDefaultDescription
projectstring-Your project key from the dashboard.
regionstring"us-east"Data centre closest to your donors.
retriesnumber3How often a failed call is retried.
timeoutMsnumber10000Time before a request is cancelled.
webhooks.enabledbooleanfalseSend events to your endpoint.

Your first request

You receive photos and updates showing exactly what your donation achieved.

  1. Create an API keyOpen the dashboard, choose Settings › API keys and copy a new secret key.
  2. Store it safelyKeep the key in an environment variable, never in your source code.
  3. Make the callRun the snippet below; it prints the first page of results.
index.js
import { Client } from "@lumen-co/sdk";

const client = new Client({ apiKey: process.env.API_KEY });

// list the newest campaigns in one category
const page = await client.campaigns.list({ category: "education", limit: 20 });

for (const item of page.data) {
  console.log(item.name, item.price);
}
Heads up: test keys only return sample data. Switch to a live key before you go to production.

API reference

Every endpoint returns JSON and uses standard HTTP status codes.

GET/v1/campaignsList campaigns with paging and filters.
POST/v1/campaignsCreate a new campaign.
PATCH/v1/campaigns/{id}Update some fields of a campaign.
DELETE/v1/campaigns/{id}Archive a campaign; it can be restored for 30 days.
response.json
{
  "data": [
    { "id": "campaign_6506", "name": "Tree planting", "price": 91 }
  ],
  "has_more": true
}

Troubleshooting

Companies can match employee donations and double their impact. We keep things simple, so you can focus on what matters to you.

Our team has done this many times, so you never have to guess. We listen first, then build a plan around what you actually need.

Every donation is tax-deductible, and receipts arrive by email instantly. We measure success by how many donors come back and tell their friends.

Next steps

Leave a gift in your will and help future generations.

Was this page helpful?
All screens