Skip to content
ContactFollowUpDocs
Docs menu

Reference

Every endpoint ContactFollowUp exposes, at a glance. Follow the per-domain pages for parameter detail and code samples.

Endpoints not yet documented in depth still work — they're called from the staff app daily. We're filling out detail pages in priority order; open an issue if a specific endpoint is blocking you.

Contacts

MethodPathSummary
POST/api/contactsCreate a contact
GET/api/contactsList contacts
GET/api/contacts/{id}Retrieve a contact
PATCH/api/contacts/{id}Update a contact
DELETE/api/contacts/{id}Soft-delete (ADMIN)
POST/api/contacts/importBulk import (CSV / JSON)
POST/api/contact-sharesGrant a teammate visibility to a contact

Companies

MethodPathSummary
POST/api/companiesCreate a company
GET/api/companiesList companies
GET/api/companies/{id}Retrieve
PATCH/api/companies/{id}Update
DELETE/api/companies/{id}Delete

Deals

MethodPathSummary
POST/api/dealsCreate a deal
GET/api/dealsList deals
GET/api/deals/{id}Retrieve
PATCH/api/deals/{id}Update (stage, amount, owner, etc.)
DELETE/api/deals/{id}Delete

Tickets

MethodPathSummary
POST/api/ticketsCreate a ticket
GET/api/ticketsList tickets
GET/api/tickets/{id}Retrieve
PATCH/api/tickets/{id}Update

Activities

MethodPathSummary
POST/api/activitiesLog an activity
GET/api/activitiesList activities
GET/api/activities/{id}Retrieve

Lists / Properties / Pipelines

MethodPathSummary
POST/api/listsCreate a list
GET/api/listsList lists
GET/api/lists/{id}Retrieve
POST/api/propertiesCreate a property definition
GET/api/propertiesList property definitions
PATCH/api/properties/{id}Update a property definition
POST/api/pipelines/v2Create a pipeline
GET/api/pipelines/v2List pipelines

Sequences & workflows

MethodPathSummary
POST/api/sequencesCreate a sequence
GET/api/sequencesList sequences
POST/api/sequences/enrollmentsEnroll a contact
POST/api/workflowsCreate a workflow
GET/api/workflowsList workflows

Email / forms / meetings

MethodPathSummary
POST/api/email-templatesCreate a template
GET/api/email-templatesList templates
POST/api/email-snippetsCreate a snippet
GET/api/email-snippetsList snippets
POST/api/formsCreate a form
GET/api/formsList forms
POST/api/meetingsCreate a meeting link
GET/api/meetingsList meeting links
GET/api/meetings/bookingsList bookings

Lead scoring

MethodPathSummary
POST/api/lead-scoring/rulesCreate a rule
GET/api/lead-scoring/rulesList rules
POST/api/lead-scoring/computeCompute score for one contact
POST/api/lead-scoring/compute-allRecompute every contact's score

Providers & appointments

MethodPathSummary
POST/api/providersCreate a provider
GET/api/providersList providers
POST/api/provider-availabilityAdd an availability rule
POST/api/appointment-typesCreate an appointment type
GET/api/appointment-typesList appointment types
POST/api/appointmentsBook an appointment
GET/api/appointmentsList appointments
PATCH/api/appointments/{id}Reschedule / cancel

Intake & check-in

MethodPathSummary
POST/api/intake-formsCreate an intake form
GET/api/intake-formsList intake forms
POST/api/intake-submissionsSubmit a patient intake (public)
POST/api/check-in/{appointmentId}Start a check-in
PATCH/api/check-in/{appointmentId}Advance the state machine

Insurance & payments

MethodPathSummary
POST/api/insuranceAdd an insurance profile
GET/api/insuranceList a contact's profiles
POST/api/paymentsRecord a payment
GET/api/paymentsList payments
POST/api/payments/checkoutStart a Stripe checkout

Inbox & secure messaging

MethodPathSummary
POST/api/inbox/webhookWebhook intake (HMAC auth)
GET/api/inboxList inbox messages
GET/api/inbox/{id}Retrieve a message
POST/api/secure-messages/threadsOpen a thread
GET/api/secure-messages/threadsList threads

EHR sync

MethodPathSummary
POST/api/ehr/syncTrigger a sync
GET/api/ehr/cursorsInspect cursors
POST/api/ehr/webhooks/{ehr}Receive a vendor webhook

Audit & compliance

MethodPathSummary
GET/api/auditQuery the audit log
GET/api/subprocessorsList subprocessors

Reports

MethodPathSummary
GET/api/reports/activityActivity volume by user / day
GET/api/reports/pipelinePipeline stage report
GET/api/reports/sequencesSequence step completion
GET/api/forecastRevenue forecast
POST/api/forecast/snapshotSnapshot the current forecast

Service accounts & teams

MethodPathSummary
POST/api/service-accountsCreate a service account
GET/api/service-accountsList service accounts
POST/api/teamsCreate a team
GET/api/teamsList teams