API Reference

Build powerful integrations with our comprehensive REST API

Getting Started

Our REST API allows you to integrate BenefitNest with your existing systems. All API requests require authentication using an API key.

# Base URL

https://api.benefitnest.space/v1

# Authentication Header

Authorization: Bearer YOUR_API_KEY

API Endpoints

GET/api/v1/employees

Retrieve a list of all employees with their benefit enrollments

POST/api/v1/claims

Submit a new claim for processing

GET/api/v1/benefits

Get available benefit plans and configurations

PUT/api/v1/enrollments/:id

Update an employee's benefit enrollment

GET/api/v1/analytics/usage

Retrieve benefit utilization analytics and reports

POST/api/v1/webhooks

Example Request

curl -X GET "https://api.benefitnest.space/v1/employees" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Example Response

{
  "data": [
    {
      "id": "emp_123",
      "name": "John Doe",
      "email": "john@company.com",
      "department": "Engineering",
      "enrollments": [
        {
          "plan_id": "plan_health_001",
          "status": "active",
          "start_date": "2025-01-01"
        }
      ]
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "per_page": 20
  }
}

📦 SDKs

JavaScript/TypeScript
Python
Ruby
Go
Java

🔔 Webhooks

Receive real-time notifications for events like claim submissions, approvals, and enrollment changes.

• claim.submitted
• claim.approved
• enrollment.created
• employee.updated

⚡ Rate Limits

Standard: 1,000 requests/minute
Enterprise: 10,000 requests/minute

Need Help?

Our developer support team is here to help with your integration.

Contact Developer Support →