Skip to content

API Reference

The Beeving API v1 exposes 145+ endpoints organized by module.

Base URL

https://app.beeving.com/api/v1

All Endpoints

Contacts

MethodEndpointDescription
GET/contactsList contacts
POST/contactsCreate a contact
POST/contacts/bulkBulk create
POST/contacts/importImport from CSV
GET/contacts/exportExport to CSV
GET/contacts/{id}Get contact
PUT/contacts/{id}Update contact
DELETE/contacts/{id}Delete contact
GET/contacts/{id}/timelineEvent history
POST/contacts/{id}/unsubscribeUnsubscribe

Lists

MethodEndpointDescription
GET/listsList all lists
POST/listsCreate a list
GET/lists/{id}Get list
PUT/lists/{id}Update list
DELETE/lists/{id}Delete list
GET/lists/{id}/contactsList contacts
POST/lists/{id}/contactsAdd contacts
DELETE/lists/{id}/contactsRemove contacts

Tags

MethodEndpointDescription
GET/tagsList tags
POST/tagsCreate a tag
GET/tags/{id}Get tag
PUT/tags/{id}Update tag
DELETE/tags/{id}Delete tag
GET/tags/{id}/contactsTagged contacts
POST/tags/{id}/contactsTag contacts

Segments

MethodEndpointDescription
GET/segmentsList segments
POST/segmentsCreate a segment
GET/segments/{id}Get segment
PUT/segments/{id}Update segment
DELETE/segments/{id}Delete segment
GET/segments/{id}/contactsSegment contacts
GET/segments/{id}/previewPreview

Campaigns

MethodEndpointDescription
GET/campaignsList campaigns
POST/campaignsCreate a campaign
GET/campaigns/{id}Get campaign
PUT/campaigns/{id}Update campaign
POST/campaigns/{id}/startStart
POST/campaigns/{id}/pausePause
POST/campaigns/{id}/resumeResume
POST/campaigns/{id}/duplicateDuplicate
GET/campaigns/{id}/statsStatistics
GET/campaigns/{id}/analyticsAnalytics
GET/campaigns/{id}/exportExport results

CRM — Companies

MethodEndpointDescription
GET/crm/companiesList companies
POST/crm/companiesCreate a company
GET/crm/companies/{id}Get company
PUT/crm/companies/{id}Update company
DELETE/crm/companies/{id}Delete company
GET/crm/companies/{id}/contactsCompany contacts
GET/crm/companies/{id}/leadsCompany leads
GET/crm/companies/{id}/dealsCompany deals

CRM — Leads

MethodEndpointDescription
GET/crm/leadsList leads
POST/crm/leadsCreate a lead
GET/crm/leads/{id}Get lead
PUT/crm/leads/{id}Update lead
DELETE/crm/leads/{id}Delete lead
POST/crm/leads/{id}/convertConvert to deal
POST/crm/leads/{id}/recalculate-scoreRecalculate score

CRM — Deals

MethodEndpointDescription
GET/crm/dealsList deals
POST/crm/dealsCreate a deal
GET/crm/deals/{id}Get deal
PUT/crm/deals/{id}Update deal
DELETE/crm/deals/{id}Delete deal
POST/crm/deals/{id}/wonMark as won
POST/crm/deals/{id}/lostMark as lost

CRM — Tasks

MethodEndpointDescription
GET/crm/tasksList tasks
POST/crm/tasksCreate a task
GET/crm/tasks/{id}Get task
PUT/crm/tasks/{id}Update task
DELETE/crm/tasks/{id}Delete task
POST/crm/tasks/{id}/completeMark as complete

CRM — Pipeline

MethodEndpointDescription
GET/crm/pipelineList stages
POST/crm/pipelineCreate a stage
POST/crm/pipeline/reorderReorder stages
PUT/crm/pipeline/{id}Update stage
DELETE/crm/pipeline/{id}Delete stage

API v1.0