Developer Hub

Build powerful integrations with the IdeaDunes REST API, webhooks, and SDKs. Everything you need to connect, extend, and automate.

API Reference Get API Key

Getting Started

Build your first integration in 5 minutes

The IdeaDunes API uses RESTful conventions with JSON request/response bodies and standard HTTP methods. Authentication is via API key or OAuth 2.0.

1. Get Your API Key

Log into your IdeaDunes dashboard, navigate to Settings > API & Integrations, and generate an API key. Keys are scoped by permission level.

2. Make Your First Request

GET /api/v1/contacts
Host: app.ideadunes.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

3. Handle the Response

{
  "data": [
    {
      "id": "c_12345",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "jane@example.com",
      "company": "Acme Corp"
    }
  ],
  "meta": {
    "total": 142,
    "page": 1,
    "per_page": 25
  }
}

4. Explore More Endpoints

The IdeaDunes API covers all major modules:

  • /api/v1/contacts — Contacts & companies
  • /api/v1/deals — Deals & pipeline
  • /api/v1/projects — Projects & tasks
  • /api/v1/tickets — Helpdesk tickets
  • /api/v1/invoices — Invoicing
  • /api/v1/users — User management

API Overview

A complete, consistent API surface

RESTful Design

Standard HTTP methods (GET, POST, PUT, PATCH, DELETE), predictable URLs, and consistent JSON responses across all endpoints.

Authentication

API key authentication for server-to-server calls. OAuth 2.0 authorization code flow for user-facing integrations with scoped permissions.

Filtering & Pagination

Query parameters for sorting, filtering by field values, date ranges, and cursor-based pagination for efficient large-dataset traversal.

Rate Limiting

Fair-use rate limits with headers showing remaining quota. Configurable limits on Enterprise plans. Automatic retry-after guidance.

Bulk Operations

Create, update, or delete up to 100 records per batch request. Reduces API calls and improves integration performance.

Error Handling

Consistent error response format with HTTP status codes, error codes, human-readable messages, and field-level validation details.

Webhooks

Real-time event notifications

Subscribe to events in IdeaDunes and receive HTTP POST callbacks to your endpoint whenever records are created, updated, or deleted.

Available Events

  • contact.created / contact.updated / contact.deleted
  • deal.created / deal.stage_changed / deal.won / deal.lost
  • task.created / task.completed / task.assigned
  • project.created / project.completed
  • ticket.created / ticket.resolved
  • invoice.sent / invoice.paid

Webhook Payload Example

{
  "event": "deal.won",
  "timestamp": "2026-03-19T14:30:00Z",
  "data": {
    "id": "d_67890",
    "name": "Acme Corp - Enterprise",
    "value": 24000,
    "currency": "USD",
    "owner": "user_123"
  },
  "webhook_id": "wh_abc123"
}

All webhook payloads include an HMAC-SHA256 signature header for verification.

SDKs & Libraries

Official client libraries

Use our official SDKs to integrate faster with type-safe methods, built-in retry logic, and automatic pagination handling.

Python

pip install ideadunes

Full API coverage, async support, and Pandas integration for data analysis.

Node.js

npm install @ideadunes/sdk

Promise-based API client with TypeScript definitions and webhook verification helpers.

PHP

composer require ideadunes/sdk

PSR-compatible HTTP client with Laravel service provider and Symfony bundle.

cURL / HTTP

Standard REST

Works with any language that supports HTTP requests. Full Postman collection available.

Resources

Developer resources

API Reference

Complete endpoint documentation with request/response examples.

View API Docs

Sandbox

Test integrations against a sandbox environment with mock data.

Get Sandbox Access

Developer Forum

Ask questions, share solutions, and connect with other developers.

Join Community

Developer Support

Priority technical support for integration and API issues.

Contact Support

Ready to start building?

Create a free account, generate your API key, and build your first integration today.