API reference

This index and the downloads remain available when the interactive reference cannot load.

• DELETE /api/agents/{agentId}Delete a discovery agent
• GET /api/agents/{agentId}Get a discovery agent
• PUT /api/agents/{agentId}Update a discovery agent
• GET /api/agents/{agentId}/discovery-funnelGet discovery results
• GET /api/agents/{agentId}/signalsList agent signals
• PUT /api/agents/{agentId}/signalsUpdate agent signals
• GET /api/agents/{agentId}/sourcesList agent sources
• PUT /api/agents/{agentId}/sources/{source}Update an agent source
• GET /api/analytics/dailyGet daily activity
• GET /api/analytics/funnelGet the outreach funnel
• GET /api/analytics/overviewGet an analytics overview
• GET /api/analytics/stepsGet step performance
• GET /api/appsList products
• POST /api/appsCreate a product
• POST /api/apps/analyze-urlAnalyze a website
• GET /api/apps/{appId}/agentsList discovery agents
• POST /api/apps/{appId}/agentsCreate a discovery agent
• GET /api/apps/{appId}/campaignsList campaigns
• POST /api/apps/{appId}/campaignsCreate a campaign
• GET /api/apps/{appId}/listsList lead lists for a product
• POST /api/apps/{appId}/listsCreate a lead list
• POST /api/apps/{appId}/lists/import-drafts/previewPreview a CSV import
• GET /api/apps/{appId}/lists/import-drafts/{importId}Get a CSV import preview
• POST /api/apps/{appId}/lists/import-drafts/{importId}/commitCommit a CSV import
• GET /api/apps/{id}Get a product
• PUT /api/apps/{id}Update a product
• POST /api/apps/{id}/generate-icpGenerate an ideal customer profile
• GET /api/billing/catalogGet the credit catalog
• GET /api/billing/current-planGet the current plan
• POST /api/campaigns/{campaignId}/enroll-list-contactsEnroll list contacts
• GET /api/campaigns/{campaignId}/enroll-list-contacts/operations/{operationId}Get an enrollment result
• GET /api/campaigns/{campaignId}/leadsList campaign leads
• POST /api/campaigns/{campaignId}/leadsAdd a lead to a campaign
• DELETE /api/campaigns/{campaignId}/leads/{leadId}Remove a lead from a campaign
• GET /api/campaigns/{campaignId}/message-reviewList messages to review
• POST /api/campaigns/{campaignId}/message-review/drafts/generateGenerate messages
• POST /api/campaigns/{campaignId}/message-review/drafts/{itemID}/approveApprove a message
• PUT /api/campaigns/{campaignId}/message-review/drafts/{itemID}/editEdit a message
• GET /api/campaigns/{campaignId}/stepsList campaign steps
• POST /api/campaigns/{campaignId}/stepsAdd a campaign step
• PUT /api/campaigns/{campaignId}/steps/reorderReorder campaign steps
• DELETE /api/campaigns/{campaignId}/steps/{stepId}Delete a campaign step
• PUT /api/campaigns/{campaignId}/steps/{stepId}Update a campaign step
• GET /api/campaigns/{id}Get a campaign
• PUT /api/campaigns/{id}Update a campaign
• POST /api/campaigns/{id}/duplicateDuplicate a campaign
• GET /api/campaigns/{id}/statsGet campaign stats
• PATCH /api/campaigns/{id}/statusStart or pause a campaign
• GET /api/contactsList contacts
• GET /api/contacts/exportExport contacts
• POST /api/contacts/exportExport selected contacts
• GET /api/contacts/{id}Get a contact
• PATCH /api/contacts/{id}/fitSet contact fit
• GET /api/discovered-leadsList discovered leads
• POST /api/discovered-leads/batch-approveApprove discovered leads
• POST /api/discovered-leads/batch-rejectReject discovered leads
• GET /api/discovered-leads/countsCount discovered leads
• GET /api/discovered-leads/{id}Get a discovered lead
• POST /api/discovered-leads/{id}/approveApprove a discovered lead
• POST /api/discovered-leads/{id}/rejectReject a discovered lead
• GET /api/inbox/conversationsList conversations
• GET /api/inbox/conversations/{id}Get a conversation
• POST /api/inbox/conversations/{id}/readMark a conversation read
• POST /api/inbox/conversations/{id}/replyReply to a conversation
• GET /api/inbox/unread-countCount unread conversations
• GET /api/listsList all lead lists
• DELETE /api/lists/{id}Delete a lead list
• GET /api/lists/{id}Get a lead list
• PUT /api/lists/{id}Update a lead list
• GET /api/lists/{id}/leadsList leads in a list
• GET /api/me/entitlementGet your plan access
• GET /api/user/limitsGet plan limits
• GET /api/users/meGet your profile
• GET /api/users/me/api-tokensList API tokens
• POST /api/users/me/api-tokensCreate an API token
• DELETE /api/users/me/api-tokens/{id}Revoke an API token
• GET /api/webhooks/outboundList webhooks
• POST /api/webhooks/outboundCreate a webhook
• GET /api/webhooks/outbound/sample-payloadGet a sample payload
• DELETE /api/webhooks/outbound/{id}Delete a webhook
• PUT /api/webhooks/outbound/{id}Update a webhook
• POST /api/webhooks/outbound/{id}/testSend a test event