Vivre API Reference
The Vivre REST API lets you build custom integrations, import and export data, and trigger Vivre actions programmatically. All requests use JSON. The API is available on Pro plans and above.
Authentication
All API requests require a Bearer token passed in the Authorization header. Generate your API key in Vivre → Settings → API Keys.
Authorization: Bearer vv_live_xxxxxxxxxxxxxxxxxxxxxxxx Content-Type: application/json X-Workspace-ID: ws_abc123
API keys are workspace-scoped. Each key has a set of permissions (read, write, admin) configured at creation time. Never expose your API key in client-side code.
GETContacts
Contacts are the people and organisations in your Vivre pipeline. Each contact can be linked to multiple deals.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max records to return. Default: 50, Max: 500 |
| offset | integer | Pagination offset. Default: 0 |
| search | string | Full-text search across name, email, company |
| score_min | integer | Filter by minimum AI score (0–100) |
{
"data": [
{
"id": "cnt_8821",
"name": "Rahul Sharma",
"email": "[email protected]",
"company": "Acme Technologies",
"ai_score": 87,
"stage": "qualified",
"created_at": "2026-06-01T08:00:00Z"
}
],
"total": 247,
"limit": 50,
"offset": 0
}
| Field | Type | Description |
|---|---|---|
| namerequired | string | Contact full name |
| emailrequired | string | Primary email address |
| company | string | Company or organisation name |
| stage | string | Pipeline stage: new | qualified | proposal | won |
| tags | array | Array of string tags |
{
"name": "Priya Kapoor",
"email": "[email protected]",
"company": "BlueStone Foods",
"stage": "qualified",
"tags": ["inbound", "demo-request"]
}
| Parameter | Description |
|---|---|
| idrequired | Contact ID (e.g. cnt_8821) |
POSTDeals
Deals represent sales opportunities in Vivre. A deal belongs to a contact and progresses through your pipeline stages.
| Field | Type | Description |
|---|---|---|
| contact_idrequired | string | ID of the associated contact |
| titlerequired | string | Deal name or title |
| value | number | Deal value in smallest currency unit (paise for INR) |
| stage | string | Pipeline stage. Default: new |
{
"contact_id": "cnt_8821",
"title": "BlueStone Foods — Annual plan",
"value": 650000, // ₹6,500
"stage": "qualified"
}
{
"stage": "won",
"closed_at": "2026-06-13T14:00:00Z"
}
POSTActivities
Log calls, emails, meetings, and notes against a contact or deal. Activities appear in the deal thread and affect AI scoring.
| Field | Type | Description |
|---|---|---|
| contact_idrequired | string | Contact this activity belongs to |
| typerequired | string | call | email | meeting | note |
| note | string | Content of the note or meeting summary |
{
"contact_id": "cnt_8821",
"deal_id": "dl_4420",
"type": "call",
"note": "Spoke for 20 mins. Interested in annual plan."
}
Errors & Rate limits
Webhook events
Vivre sends webhook events to your endpoint when key actions happen. Register your endpoint in Vivre → Settings → Webhooks.
contact.created // New contact added contact.updated // Contact fields changed contact.scored // AI score recalculated deal.created // New deal opened deal.stage_changed // Deal moved to a new stage deal.won // Deal marked as Won activity.logged // Call / email / note logged
Each webhook POST includes an X-Vivre-Signature header for HMAC-SHA256 verification. Respond with HTTP 200 within 5 seconds to acknowledge.