← Documentation
API reference
Use your own client to send requests. Examples can read or change account data.
Loading API reference… Use the endpoint index or download the specification below.
Plain endpoint index · 270 operations
This index and the downloads remain available when the interactive reference cannot load.
POST /api/agent/attachmentsUploadGET /api/agent/capabilitiesList operator capabilitiesPOST /api/agent/messagesStreamGET /api/agent/threadsList agent threadsPOST /api/agent/threadsCreate agent threadsDELETE /api/agent/threads/{threadId}Delete agent threadsGET /api/agent/threads/{threadId}Get agent threadsPATCH /api/agent/threads/{threadId}Update agent threadsGET /api/agent/threads/{threadId}/messagesList MessagesDELETE /api/agents/{agentId}Delete agentsGET /api/agents/{agentId}Get agentsPUT /api/agents/{agentId}Update agentsGET /api/agents/{agentId}/discovery-funnelGet Discovery FunnelPOST /api/agents/{agentId}/generate-keywordsGenerate KeywordsGET /api/agents/{agentId}/next-launchesNext LaunchesPOST /api/agents/{agentId}/previewPreview SignalGET /api/agents/{agentId}/rejected-profilesGet Rejected Profiles For ClassPOST /api/agents/{agentId}/rejected-profiles/bulk-promoteBatch Promote Rejected ProfilesPOST /api/agents/{agentId}/rejected-profiles/{rawId}/promotePromote Rejected ProfileGET /api/agents/{agentId}/rejected-profiles/{rawId}/promote-statusPromote Rejected Profile StatusGET /api/agents/{agentId}/rejectionsGet Rejection BreakdownGET /api/agents/{agentId}/signalsList SignalsPUT /api/agents/{agentId}/signalsUpdate SignalsPOST /api/agents/{agentId}/signals/{signalId}/launchLaunch SignalGET /api/agents/{agentId}/sourcesList SourcesPOST /api/agents/{agentId}/sources/hackernews/generate-queriesGenerate Hacker News QueriesPUT /api/agents/{agentId}/sources/{source}Update SourceGET /api/analytics/dailyDaily ActivityGET /api/analytics/daily-overviewDaily OverviewGET /api/analytics/funnelFunnel AnalysisGET /api/analytics/overviewOverviewGET /api/analytics/signalsSignal StatsGET /api/analytics/sourcesSource StatsGET /api/analytics/stepsStep StatsGET /api/appsList appsPOST /api/appsCreate appsPOST /api/apps/analyze-textAnalyze TextPOST /api/apps/analyze-urlAnalyze URLGET /api/apps/statsStats appsGET /api/apps/{appId}/agentsList agentsPOST /api/apps/{appId}/agentsCreate agentsGET /api/apps/{appId}/campaignsList campaignsPOST /api/apps/{appId}/campaignsCreate campaignsPOST /api/apps/{appId}/campaigns/preflightPreflight CreateGET /api/apps/{appId}/listsList By AppPOST /api/apps/{appId}/listsCreate lead listsPOST /api/apps/{appId}/lists/importImportPOST /api/apps/{appId}/lists/import-drafts/previewPreview people csvimportGET /api/apps/{appId}/lists/import-drafts/{importId}Get people csvimportPOST /api/apps/{appId}/lists/import-drafts/{importId}/commitCommitGET /api/apps/{appId}/specialist-activityList specialist activityGET /api/apps/{appId}/specialist-runsList RunsGET /api/apps/{appId}/specialist-runs/{runId}Get RunGET /api/apps/{id}Get appsPUT /api/apps/{id}Update appsPOST /api/apps/{id}/generate-icpGenerate ICPPOST /api/auth/loginLoginPOST /api/auth/logoutLogoutGET /api/auth/oauth/{provider}/startStartPOST /api/auth/refreshRefreshPOST /api/auth/signupSignupGET /api/billing/beta-rewardsBeta RewardsGET /api/billing/catalogCredit CatalogGET /api/billing/current-planCurrent PlanGET /api/booking-provider-events/unmatchedList Unmatched EventsPOST /api/booking-provider-events/{id}/attachAttach Provider EventPOST /api/booking-provider-events/{id}/dismissDismiss Provider EventGET /api/booking-providersList booking providersPOST /api/booking-providers/calcom/api-keyConnect Calcom APIKeyDELETE /api/booking-providers/{id}DisconnectPOST /api/booking-providers/{id}/backfillBackfill Provider BookingsPOST /api/booking-providers/{id}/verifyVerifyPOST /api/booking-providers/{id}/webhook/registerRegister WebhookPOST /api/booking-providers/{provider}/oauth/startStart OAuthPOST /api/campaigns/{campaignId}/enroll-list-contactsEnroll List ContactsGET /api/campaigns/{campaignId}/enroll-list-contacts/operations/{operationId}Get Selected Enrollment ReceiptGET /api/campaigns/{campaignId}/enroll-list-contacts/receipts/{receiptId}Get Selected Enrollment ReceiptGET /api/campaigns/{campaignId}/in-flight-impactIn Flight ImpactPOST /api/campaigns/{campaignId}/leadsAdd LeadDELETE /api/campaigns/{campaignId}/leads/{leadId}Remove LeadGET /api/campaigns/{campaignId}/message-reviewList message reviewPOST /api/campaigns/{campaignId}/message-review/drafts/generateGenerate DraftsPOST /api/campaigns/{campaignId}/message-review/drafts/{itemID}/approveApprove DraftPUT /api/campaigns/{campaignId}/message-review/drafts/{itemID}/editEdit DraftPOST /api/campaigns/{campaignId}/message-review/drafts/{itemID}/retryRetry DraftPOST /api/campaigns/{campaignId}/message-review/drafts/{itemID}/reviseRevise DraftPOST /api/campaigns/{campaignId}/message-review/examples/generateGenerate ExamplesPOST /api/campaigns/{campaignId}/message-review/examples/saveSave ExamplesPUT /api/campaigns/{campaignId}/message-review/examples/{exampleID}Edit ExamplePUT /api/campaigns/{campaignId}/message-review/policySet PolicyPOST /api/campaigns/{campaignId}/message-review/quoteQuoteGET /api/campaigns/{campaignId}/scheduled-actionsList GroupedPOST /api/campaigns/{campaignId}/scheduled-actions/batch-approveBatch ApprovePOST /api/campaigns/{campaignId}/scheduled-actions/cancel-country-restrictedCancel Country Restricted PlannedGET /api/campaigns/{campaignId}/scheduled-actions/country-restriction-impactCountry Restriction ImpactPOST /api/campaigns/{campaignId}/scheduled-actions/reschedule-overdueReschedule OverduePOST /api/campaigns/{campaignId}/scheduled-actions/reschedule-plannedReschedule PlannedGET /api/campaigns/{campaignId}/stepsList workflow stepsPOST /api/campaigns/{campaignId}/stepsCreate workflow stepsPUT /api/campaigns/{campaignId}/steps/message-modeBulk Set Message ModePUT /api/campaigns/{campaignId}/steps/reorderReorderDELETE /api/campaigns/{campaignId}/steps/{stepId}Delete workflow stepsPUT /api/campaigns/{campaignId}/steps/{stepId}Update workflow stepsGET /api/campaigns/{campaignId}/steps/{stepId}/affected-countsAffected CountsDELETE /api/campaigns/{campaignId}/steps/{stepId}/attachmentDelete AttachmentPOST /api/campaigns/{campaignId}/steps/{stepId}/attachmentUpload AttachmentGET /api/campaigns/{id}Get campaignsPUT /api/campaigns/{id}Update campaignsPOST /api/campaigns/{id}/duplicateDuplicateGET /api/campaigns/{id}/enrollment-previewEnrollment PreviewPOST /api/campaigns/{id}/generate-all-messagesGenerate All MessagesPOST /api/campaigns/{id}/generate-messageGenerate MessageGET /api/campaigns/{id}/signalsList SignalsPUT /api/campaigns/{id}/signalsUpdate SignalsGET /api/campaigns/{id}/statsStats campaignsPATCH /api/campaigns/{id}/statusUpdate StatusGET /api/campaigns/{id}/step-repliesStep RepliesPOST /api/company-decision-maker-imports/eventsEventPOST /api/company-decision-maker-imports/previewPreview company decision maker importPOST /api/company-decision-maker-imports/{jobID}/approvalApproveGET /api/company-decision-maker-imports/{jobID}/approved-membersApproved MembersPOST /api/company-decision-maker-imports/{jobID}/batch-previewBatch PreviewGET /api/company-decision-maker-imports/{jobID}/company-outcomesCompany OutcomesPOST /api/company-decision-maker-imports/{jobID}/confirmConfirm company decision maker importGET /api/company-decision-maker-imports/{jobID}/metricsMetricsGET /api/company-decision-maker-imports/{jobID}/progressProgressGET /api/company-decision-maker-imports/{jobID}/resultsResultsPOST /api/company-decision-maker-imports/{jobID}/retryRetry company decision maker importGET /api/company-decision-maker-imports/{jobID}/rowsRowsGET /api/contactsList contactsGET /api/contacts/exportExport contactsPOST /api/contacts/exportExport contactsGET /api/contacts/{id}DetailPATCH /api/contacts/{id}/fitUpdate Fit StatusDELETE /api/contacts/{id}/pinUnpinPUT /api/contacts/{id}/pinPinGET /api/dashboard/next-eventNext EventGET /api/discovered-leadsList discovered leadsPOST /api/discovered-leads/batch-approveBatch ApprovePOST /api/discovered-leads/batch-rejectBatch RejectGET /api/discovered-leads/countsStatus CountsGET /api/discovered-leads/{id}DetailPOST /api/discovered-leads/{id}/approveApprovePOST /api/discovered-leads/{id}/refreshRefreshPOST /api/discovered-leads/{id}/rejectRejectGET /api/discovered-leads/{id}/sequenceSequencePOST /api/enrichment/contacts/{id}Enrich ContactPOST /api/enrichment/discovered-leads/{id}Enrich Discovered LeadPOST /api/enrichment/discovered-leads/{id}/resolve-linkedinResolve Discovered Lead Linked InPOST /api/enrichment/list-members/{id}/resolve-linkedinResolve Lead List Member Linked InGET /api/featuresGet FeaturesGET /api/follow-upsList follow upsPOST /api/follow-ups/leads/{leadId}/dismissDismissGET /api/follow-ups/leads/{leadId}/notesList NotesPOST /api/follow-ups/leads/{leadId}/notesCreate NoteGET /api/follow-ups/pending-countPending CountPOST /api/follow-ups/reminders/{id}/completeComplete ReminderGET /api/ideasList ideasPOST /api/ideasCreate ideasDELETE /api/ideas/{id}Delete ideasPUT /api/ideas/{id}Update ideasDELETE /api/ideas/{id}/voteUnvotePOST /api/ideas/{id}/voteVoteGET /api/inbox/conversationsList ConversationsGET /api/inbox/conversations/syncSync ConversationsGET /api/inbox/conversations/{chatId}/messages/liveLive MessagesGET /api/inbox/conversations/{chatId}/messages/{messageId}/attachments/{attachmentId}Get Message AttachmentPOST /api/inbox/conversations/{chatId}/reply-liveSend Live ReplyGET /api/inbox/conversations/{id}Get ConversationDELETE /api/inbox/conversations/{id}/ai-replyDismiss AIDraftPOST /api/inbox/conversations/{id}/ai-replyGenerate ReplyPOST /api/inbox/conversations/{id}/readMark ReadPOST /api/inbox/conversations/{id}/replySend ReplyGET /api/inbox/unread-countUnread CountGET /api/insightsList InsightsGET /api/insights/countCount Open InsightsPOST /api/insights/{id}/applyApply InsightPATCH /api/insights/{id}/statusUpdate Insight StatusGET /api/integrationsList integrationsPOST /api/integrationsInstallGET /api/integrations/clay/eventsList EventsPOST /api/integrations/clay/events/{eventID}/confirmConfirm clayPOST /api/integrations/clay/installInstallPOST /api/integrations/verifyVerifyDELETE /api/integrations/{id}UninstallGET /api/integrations/{id}Get integrationsPUT /api/integrations/{id}Update integrationsPOST /api/integrations/{id}/testVerify By IDPATCH /api/leads/{id}PatchPOST /api/leads/{leadId}/mark-repliedMark Lead RepliedGET /api/leads/{leadId}/meetingsList For LeadPOST /api/leads/{leadId}/meetingsCreate For LeadPOST /api/leads/{leadId}/reenrollReenroll LeadGET /api/listsList AllDELETE /api/lists/{id}Delete lead listsGET /api/lists/{id}Get lead listsPUT /api/lists/{id}Update lead listsGET /api/lists/{id}/leadsList LeadsPOST /api/mcp/approvals/approveApprove ActionPOST /api/mcp/approvals/inspectInspect ApprovalGET /api/me/active-agentsActive AgentsGET /api/me/active-offerGet Active Offer For MeGET /api/me/announcementsList announcementsPOST /api/me/announcements/{id}/cta-clickCTAClickPOST /api/me/announcements/{id}/dismissDismissGET /api/me/entitlementGet entitlementGET /api/me/notificationsList notificationsPOST /api/me/notifications/read-allMark All ReadGET /api/me/notifications/unread-countUnread CountPOST /api/me/notifications/{id}/readMark ReadGET /api/me/recent-signal-runsRecent Signal RunsGET /api/me/workspacesList WorkspacesPOST /api/me/workspaces/demo/joinJoin Demo WorkspaceDELETE /api/me/workspaces/{member_id}Leave WorkspacePATCH /api/meetings/{id}Update meetingsGET /api/onboarding/progressGet ProgressGET /api/operator/memoryList operator memoryPUT /api/operator/memoryUpsertDELETE /api/operator/memory/{memoryID}Delete operator memoryPUT /api/operator/notification-preferencesSet Notification PreferenceGET /api/operator/outcomesGet operator outcomesGET /api/operator/tasksList operator tasksGET /api/operator/tasks/{taskID}Get operator tasksGET /api/operator/tasks/{taskID}/actionsActionsGET /api/operator/tasks/{taskID}/eventsEventsPOST /api/operator/tasks/{taskID}/retryRetry operator tasksPOST /api/operator/tasks/{taskID}/{operation}ControlGET /api/platform-accountsList platform accountsPOST /api/platform-accountsCreate platform accountsDELETE /api/platform-accounts/{id}Delete platform accountsPOST /api/platform-accounts/{id}/connectConnectPATCH /api/platform-accounts/{id}/email-signatureUpdate Email SignaturePOST /api/platform-accounts/{id}/enrichEnrichPATCH /api/platform-accounts/{id}/invite-withdrawalUpdate Invite WithdrawalPATCH /api/platform-accounts/{id}/limitsUpdate LimitsGET /api/platform-accounts/{id}/setup-statusSetup StatusGET /api/platform-accounts/{id}/usageUsagePATCH /api/platform-accounts/{id}/warmup-skipUpdate Warmup SkipGET /api/scheduled-actions/{id}Get ActionPOST /api/scheduled-actions/{id}/approveApprove ActionPOST /api/scheduled-actions/{id}/skipSkip ActionGET /api/table-viewsList table viewsPOST /api/table-viewsUpsertDELETE /api/table-views/{id}Delete table viewsGET /api/team/invitationsList Pending InvitationsPOST /api/team/invitationsInviteGET /api/team/invitations/by-token/{token}Get Public InvitationPOST /api/team/invitations/by-token/{token}/acceptAccept InvitationDELETE /api/team/invitations/{id}Revoke InvitationGET /api/team/membersList MembersGET /api/team/members/auditList Member AuditDELETE /api/team/members/{id}Remove MemberPUT /api/team/members/{id}Update Member AppsPATCH /api/team/members/{id}/roleUpdate Member RoleGET /api/user/limitsLimitsGET /api/users/meGet MePATCH /api/users/meUpdate MeGET /api/users/me/api-tokensList api tokensPOST /api/users/me/api-tokensCreate api tokensDELETE /api/users/me/api-tokens/{id}RevokePOST /api/users/me/change-passwordChange PasswordGET /api/users/me/sessionsList user sessionsDELETE /api/users/me/sessions/{id}RevokeGET /api/webhooks/outboundList webhook outboundPOST /api/webhooks/outboundCreate webhook outboundGET /api/webhooks/outbound/sample-payloadSample PayloadPOST /api/webhooks/outbound/test-urlTest URLDELETE /api/webhooks/outbound/{id}Delete webhook outboundPUT /api/webhooks/outbound/{id}Update webhook outboundPOST /api/webhooks/outbound/{id}/testTest