NeedBridge API

Integrate volunteer coordination into your applications with our powerful RESTful API

API Overview

The NeedBridge API provides programmatic access to all platform features, enabling seamless integration with your existing systems.

RESTful Design

Standard HTTP methods and status codes for predictable API behavior

API Key Auth

Secure authentication with API keys and role-based permissions

Real-time Events

Webhook notifications for real-time updates and integrations

Rate Limited

Fair usage policies with generous rate limits for all use cases

Getting Started

Follow these steps to start integrating with the NeedBridge API

1. Authentication

All API requests require authentication using an API key. Include your API key in the request headers:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.needbridge.com/api/needs

Getting Your API Key: API keys are available to organization administrators in the admin dashboard under Settings → API Keys.

2. Making Requests

All requests should include the appropriate Content-Type header and use JSON for request bodies:

// Creating a new need
curl -X POST https://api.needbridge.com/api/needs \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "title": "Groceries for family of 4",
       "description": "Need basic groceries",
       "urgency": "high",
       "dueDate": "2024-12-31T23:59:59Z"
     }'

3. Response Format

All API responses follow a consistent JSON structure with appropriate HTTP status codes:

// Success Response (200/201)
{
  "success": true,
  "data": {
    "id": "need_123",
    "title": "Groceries for family of 4",
    "status": "open",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

4. Webhooks

Configure webhook endpoints in your admin dashboard to receive real-time notifications:

// Webhook payload example
{
  "event": "need.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "id": "need_123",
    "title": "Groceries for family of 4",
    "organizationId": "org_456",
    "status": "open"
  }
}

API Endpoints

Core endpoints for managing needs, volunteers, and organizational data

GET

GET /api/needs

Retrieve all needs with filtering options

Parameters:

area

string

Filter by area ID

status

string

Filter by need status

urgency

string

Filter by urgency level

category

string

Filter by category

POST

POST /api/needs

Create a new community assistance need

Parameters:

title

string

Need title (required)

description

string

Detailed description

urgency

string

critical | high | medium | low

dueDate

string

ISO date string

areaId

string

Geographic area ID

GET

GET /api/needs/{id}

Get details for a specific need

Parameters:

id

string

Need ID (required)

POST

POST /api/needs/{id}/claim

Claim a need (volunteer action)

Parameters:

id

string

Need ID (required)

volunteerName

string

Volunteer name

volunteerEmail

string

Volunteer email

quantity

number

Quantity to claim

POST

POST /api/needs/{id}/fulfill

Mark a need as fulfilled

Parameters:

id

string

Need ID (required)

donationValue

number

Estimated donation value

itemDescription

string

Description of donated items

Webhook Events

Real-time notifications for important platform events

need.created

Webhook

Triggered when a new need is created

Payload: Need object with full details

need.claimed

Webhook

Triggered when a need is claimed by a volunteer

Payload: Need object with volunteer information

need.fulfilled

Webhook

Triggered when a need is marked as fulfilled

Payload: Need object with fulfillment details

volunteer.registered

Webhook

Triggered when a volunteer registers

Payload: Volunteer object with registration details

tax_receipt.generated

Webhook

Triggered when a tax receipt is generated

Payload: Tax receipt object with PDF URL

Integration Examples

Common integration patterns and use cases

Zapier Integration

Connect NeedBridge with 5,000+ apps using our official Zapier integration.

✓Sync needs to Google Sheets or Airtable
✓Send Slack notifications for new needs
✓Create calendar events for volunteer activities

Custom Integrations

Build custom integrations with your existing systems using our REST API.

✓Sync volunteer data with your CRM
✓Integrate with your website or mobile app
✓Connect with accounting or reporting systems

Ready to Start Building?

Get your API key and start integrating NeedBridge into your applications today

Get API Access Contact Support