Using the REST API

Overview

The REST API allows you to read and write data programmatically, enabling custom integrations with your internal tools, data warehouse, or third-party applications.

Authentication

All API requests require a Bearer token. To generate an API key:

1. Go to Settings > API & Webhooks.
2. Click Generate New Key.
3. Copy the key immediately — it will not be shown again.

Pass your key in the request header: Authorization: Bearer YOUR_API_KEY

Base URL

All API endpoints are served from: https://api.platform.example.com/v2/

Common Endpoints

• GET /contacts — List all contacts
• POST /contacts — Create a contact
• GET /deals/{id} — Retrieve a specific deal
• PATCH /deals/{id} — Update deal fields
• GET /activities — List activity log entries

Rate Limits

API requests are limited to 1,000 per minute per organization on the Business plan and 5,000 per minute on the Enterprise plan. Requests exceeding this limit will receive a 429 Too Many Requests response.

Full API reference documentation is available in the Developer Portal.