API Documentation
RESTful API documentation for developers
https://api.lotscrm.comAPI Key (Bearer token or X-API-Key header)
39
Authentication
All API requests require authentication using an API key. You can create an API key from your dashboard.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.lotscrm.com/api/v1/lotscrm/follow-upsactivities
/api/v1/lotscrm/follow-upsCreate follow-up
create_follow_upCreate a due task linked to a contact, company, or deal. This schedules work; it does not send outreach.
/api/v1/lotscrm/activitiesGet relationship timeline
get_timelineGet recent activities linked to any supplied contact, company, or deal.
/api/v1/lotscrm/follow-upsList follow-ups
list_follow_upsList due, overdue, completed, or owner-assigned follow-ups. Omitted completed returns open work.
/api/v1/lotscrm/activitiesRecord sales activity
record_activityRecord a call, meeting, email, message, note, or other completed interaction. This records history and never sends a message.
/api/v1/lotscrm/follow-ups/:follow_up_idUpdate follow-up
update_follow_upReschedule, reassign, edit, complete, or reopen a follow-up.
companies
/api/v1/lotscrm/companies/:company_idArchive company
archive_companyRecoverably archive a company; associated contacts and deals remain intact.
/api/v1/lotscrm/companiesCreate company
create_companyCreate a company with provenance and optional custom fields.
/api/v1/lotscrm/companies/:company_idGet company
get_companyGet a company with its contacts and active deals.
/api/v1/lotscrm/companiesList companies
list_companiesList active companies with search, lifecycle filtering, and pagination.
/api/v1/lotscrm/companies/:company_idUpdate company
update_companyUpdate a company in the selected workspace. Only the fields you send change; custom_fields merges (null removes a key).
contacts
/api/v1/lotscrm/contacts/:contact_idArchive contact
archive_contactRecoverably archive a contact. Existing deal and activity history remains intact.
/api/v1/lotscrm/contacts/bulkBulk upsert prospects
bulk_upsert_prospectsImport 1–100 researched or CSV-derived prospects. Email is the workspace deduplication key. Each row retains source and source_url provenance, and can carry tags and a company_name.
/api/v1/lotscrm/contactsCreate contact
create_contactCreate a contact with consent, provenance, and optional company relationship.
/api/v1/lotscrm/contacts/:contact_idGet contact
get_contactGet a contact with company relationships, deals, and channels.
/api/v1/lotscrm/contactsList contacts
list_contactsList active contacts with lead status, owner, search, and pagination filters.
/api/v1/lotscrm/contacts/:contact_idUpdate contact
update_contactUpdate contact qualification, consent, ownership, details, or company relationship. Only the fields you send change; custom_fields merges (null removes a key).
deals
/api/v1/lotscrm/deals/:deal_idArchive deal
archive_dealRecoverably archive a deal using optimistic concurrency.
/api/v1/lotscrm/dealsCreate deal
create_dealCreate a deal in an owned pipeline and stage with optional company and contacts.
/api/v1/lotscrm/deals/:deal_idGet deal
get_dealGet a deal with its stage, company, contacts, and stage history.
/api/v1/lotscrm/dealsList deals
list_dealsList active deals by pipeline, stage, status, owner, or search text.
/api/v1/lotscrm/deals/:deal_id/moveMove deal
move_dealMove a deal to another stage atomically with status and stage history. Lost deals require lost_reason.
/api/v1/lotscrm/deals/:deal_idUpdate deal
update_dealUpdate deal details using expected_version to prevent an agent overwriting newer work. Use move_deal for stage changes. custom_fields merges (null removes a key).
insights
/api/v1/lotscrm/crm-briefingGet CRM briefing
get_crm_briefingMandatory first read for CRM agents. Return the selected workspace, caller role, separately labelled public business truth and private guidance, pipeline configuration, and current sales priorities.
/api/v1/lotscrm/sales-briefGet daily sales brief
get_sales_briefReturn deterministic sales priorities together with separately labelled workspace business context projected from LotsNotes.
/api/v1/lotscrm/deals/:deal_id/briefGet deal briefing
get_deal_briefReturn complete pre-call context: workspace business context, deal, stage, company, contacts, recent activity, open follow-ups, and contact restrictions.
/api/v1/lotscrm/pipeline-summaryGet pipeline summary
get_pipeline_summaryReturn deal counts, raw value, and weighted value per stage and currency without mixing currencies.
/api/v1/lotscrm/deals/:deal_id/prepare-follow-upPrepare follow-up context
prepare_follow_upReturn grounded CRM and workspace business context plus safety instructions for drafting. It never sends and blocks opted-out or do-not-contact records.
/api/v1/lotscrm/searchSearch CRM
search_crmSearch contacts, companies, and deals in one accessible workspace.
pipeline
/api/v1/lotscrm/pipelinesCreate sales pipeline
create_pipelineCreate a custom pipeline with ordered open, won, and lost stages. Owner or admin required.
/api/v1/lotscrm/pipelinesList sales pipelines
list_pipelinesList pipelines and their ordered stages.
workspace
/api/v1/lotscrm/workspaces/:workspace_id/membersAdd CRM member
add_memberAdd an existing Lots Auth user to a workspace by email. Owner or admin required.
/api/v1/lotscrm/workspacesCreate CRM workspace
create_workspaceCreate an isolated CRM workspace. With no organization_id, also creates the owner organization and a default six-stage sales pipeline. Retry with the same idempotency_key.
/api/v1/lotscrm/workspaces/:workspace_idGet CRM workspace
get_workspaceGet one accessible CRM workspace and the caller role.
/api/v1/lotscrm/workspaces/:workspace_id/membersList CRM members
list_membersList members of an accessible CRM workspace.
/api/v1/lotscrm/workspacesList CRM workspaces
list_workspacesList active CRM workspaces available to the authenticated user.
/api/v1/lotscrm/workspaces/:workspace_id/members/:user_idUpdate CRM member
update_memberChange or suspend a workspace member. The owner cannot be changed through this tool.
/api/v1/lotscrm/workspaces/:workspace_idUpdate CRM workspace
update_workspaceUpdate workspace operating settings. Owner or admin required.
billing
/api/v1/lotscrm/checkoutChoose a LotsCRM plan or add credits
create_checkoutCreate a checkout link. Pass plan (starter, pro or business) and cycle (monthly or annual) for a plan, or amount_usd (10 to 1000) to add LotsTech Credits. Give the link to the person to pay in their browser; never ask for card details in chat.
/api/v1/lotscrm/billingGet LotsCRM billing
get_billingShow how the caller's LotsCRM workspaces are paid for: the plan (if any), whether today is covered or paid from credits, the credit balance, and the plans to choose from. A workspace nobody pays for is read-only, never deleted.