API Reference
Libraries
API Overview
Auth
Me
GET/v1/auth/me
Ensure Workspace
POST/v1/auth/ensure-workspace
Ensure User Profile
POST/v1/auth/ensure-user-profile
Ensure Creator Profile
POST/v1/auth/ensure-creator-profile
Admin
Create Internal Demo Workspace
POST/v1/admin/demo-workspaces
AdminBrand Workspaces
List Brand Workspaces
GET/v1/admin/brand-workspaces
Create Brand Team Invite
POST/v1/admin/brand-workspaces/{workspace_id}/team-invites
AdminProspect Invites
List Prospect Invites
GET/v1/admin/prospect-invites
Create Prospect Invite
POST/v1/admin/prospect-invites
Revoke Prospect Invite
POST/v1/admin/prospect-invites/{invite_id}/revoke
AdminBackfills
Run Role Assignments Backfill
POST/v1/admin/backfills/role-assignments
Run Thread Campaign Creator Id Backfill
POST/v1/admin/backfills/thread-campaign-creator-id
Run Dedupe Legacy Event Messages
POST/v1/admin/backfills/dedupe-legacy-event-messages
Run Starter Trial Plan Source Backfill
POST/v1/admin/backfills/starter-trial-plan-source
API Keys
List Api Keys
GET/v1/api-keys
Create Api Key
POST/v1/api-keys
Revoke Api Key
DELETE/v1/api-keys/{api_key_id}
Approval Requests
List Approval Requests
GET/v1/approval-requests
Approve Request
POST/v1/approval-requests/{approval_request_id}/approve
Reject Request
POST/v1/approval-requests/{approval_request_id}/reject
Provider Events
Receive Composio Event
POST/v1/provider-events/composio
Verify Whatsapp Webhook
GET/v1/provider-events/whatsapp
Receive Whatsapp Event
POST/v1/provider-events/whatsapp
Companies
Get Company
GET/v1/companies/{company_id}
Update Company
PATCH/v1/companies/{company_id}
Workspaces
List Workspaces
GET/v1/workspaces
Create Workspace
POST/v1/workspaces
Get Current Workspace
GET/v1/workspaces/current
Get Workspace
GET/v1/workspaces/{workspace_id}
Update Workspace
PATCH/v1/workspaces/{workspace_id}
WorkspacesTeams
List Teams
GET/v1/workspaces/{workspace_id}/teams
Create Team
POST/v1/workspaces/{workspace_id}/teams
Update Team
PATCH/v1/workspaces/{workspace_id}/teams/{team_id}
Delete Team
DELETE/v1/workspaces/{workspace_id}/teams/{team_id}
WorkspacesTeamsMembers
List Team Members
GET/v1/workspaces/{workspace_id}/teams/{team_id}/members
Add Team Member
POST/v1/workspaces/{workspace_id}/teams/{team_id}/members
Remove Team Member
DELETE/v1/workspaces/{workspace_id}/teams/{team_id}/members/{user_id}
WorkspacesTeamsInvites
List Team Invites
GET/v1/workspaces/{workspace_id}/teams/{team_id}/invites
Create Team Invite
POST/v1/workspaces/{workspace_id}/teams/{team_id}/invites
WorkspacesRoles
List Roles
GET/v1/workspaces/{workspace_id}/roles
WorkspacesRole Assignments
List Role Assignments
GET/v1/workspaces/{workspace_id}/role-assignments
Team Invites
Resolve Team Invite
GET/v1/team-invites/{token}
Accept Team Invite
POST/v1/team-invites/{token}/accept
Decline Team Invite
POST/v1/team-invites/{token}/decline
Refresh Team Invite
POST/v1/team-invites/{invite_id}/refresh
Revoke Team Invite
POST/v1/team-invites/{invite_id}/revoke
Prospect Invites
Resolve Prospect Invite
GET/v1/prospect-invites/{token}
Mark Prospect Invite Viewed
POST/v1/prospect-invites/{token}/view
Accept Prospect Invite
POST/v1/prospect-invites/{token}/accept
Credits
Get Credits
GET/v1/credits
Billing
Create Checkout Session
POST/v1/billing/checkout-session
Create Portal Session
POST/v1/billing/portal-session
Get Region
GET/v1/billing/region
Cancel Subscription
POST/v1/billing/subscriptions/cancel
Resume Subscription
POST/v1/billing/subscriptions/resume
Invoice Charges
Brand Create Invoice Draft
POST/v1/brand/campaigns/{campaign_id}/invoices
Creator Confirm Invoice
POST/v1/me/invoices/{invoice_id}/confirm
Brand Pay Invoice
POST/v1/invoices/{invoice_id}/pay
Creator List Pending Invoices
GET/v1/me/invoices
Payouts
Get Payout Info
GET/v1/me/payout-info
Create Stripe Connect Link
POST/v1/me/payout-account/stripe-connect-link
Discovery Searches
List Discovery Searches
GET/v1/discovery-searches
Create Discovery Search
POST/v1/discovery-searches
Get Discovery Search
GET/v1/discovery-searches/{discovery_search_id}
List Discovery Results
GET/v1/discovery-searches/{discovery_search_id}/results
List Discovery Result Summaries
GET/v1/discovery-searches/{discovery_search_id}/results/summary
Persist Selected Discovery Results
POST/v1/discovery-searches/{discovery_search_id}/results/selected
Proceed Discovery Search
POST/v1/discovery-searches/{discovery_search_id}/proceed
Cancel Discovery Search
POST/v1/discovery-searches/{discovery_search_id}/cancel
Analyze Discovery Brief
POST/v1/discovery-searches/analyze-brief
Cluster Discovery Searches
List Cluster Discovery Searches
GET/v1/cluster-discovery-searches
Create Cluster Discovery Search
POST/v1/cluster-discovery-searches
Get Cluster Discovery Search
GET/v1/cluster-discovery-searches/{discovery_search_id}
List Cluster Discovery Results
GET/v1/cluster-discovery-searches/{discovery_search_id}/results
List Cluster Discovery Events
GET/v1/cluster-discovery-searches/{discovery_search_id}/events
Answer Cluster Discovery Questions
POST/v1/cluster-discovery-searches/{discovery_search_id}/answer
Cancel Cluster Discovery Search
POST/v1/cluster-discovery-searches/{discovery_search_id}/cancel
Discovery Agent Runs
Create Discovery Agent Run
POST/v1/discovery-agent-runs
Get Discovery Agent Run
GET/v1/discovery-agent-runs/{workflow_run_id}
List Discovery Agent Events
GET/v1/discovery-agent-runs/{workflow_run_id}/events
Cancel Discovery Agent Run
POST/v1/discovery-agent-runs/{workflow_run_id}/cancel
Creators
Creators By Creator Ids
POST/v1/creators/by-creator-ids
Resolve Creator By Handle
GET/v1/creators/resolve-by-handle/{platform}/{handle}
Get Creator
GET/v1/creators/{platform}/{creator_id}
Get Creator Media Kit
GET/v1/creators/{platform}/{creator_id}/media-kit
Get Creator Posts
GET/v1/creators/{platform}/{creator_id}/posts
Get Creator Brands
GET/v1/creators/{platform}/{creator_id}/brands
Get Creator Demographics
GET/v1/creators/{platform}/{creator_id}/demographics
Get Creator Lookalikes
GET/v1/creators/{platform}/{creator_id}/lookalikes
Refresh Creator Media Kit
POST/v1/creators/{platform}/{creator_id}/media-kit/refresh
Campaigns
List Campaigns
GET/v1/campaigns
Create Campaign
POST/v1/campaigns
Get Campaign
GET/v1/campaigns/{campaign_id}
Update Campaign
PATCH/v1/campaigns/{campaign_id}
Delete Campaign
DELETE/v1/campaigns/{campaign_id}
Duplicate Campaign
POST/v1/campaigns/{campaign_id}/duplicate
Enrich Campaign Contacts
POST/v1/campaigns/{campaign_id}/contacts/enrich
Enrich Campaign Profiles Route
POST/v1/campaigns/{campaign_id}/profiles/enrich
Start Outreach Route
POST/v1/campaigns/{campaign_id}/outreach/start
Bulk Email Route
POST/v1/campaigns/{campaign_id}/outreach/bulk-email
Get Campaign Activity Route
GET/v1/campaigns/{campaign_id}/activity
Post Campaign Note Route
POST/v1/campaigns/{campaign_id}/notes
Get Campaign Metrics Health Route
GET/v1/campaigns/{campaign_id}/metrics/health
Get Campaign Metrics Roi Route
GET/v1/campaigns/{campaign_id}/metrics/roi
Get Campaign Metrics Timeseries Route
GET/v1/campaigns/{campaign_id}/metrics/timeseries
Get Campaign Metrics Clicks Route
GET/v1/campaigns/{campaign_id}/metrics/clicks
List Campaign Content Submissions Route
GET/v1/campaigns/{campaign_id}/content-submissions
Enrich Campaign Emails
POST/v1/campaigns/{campaign_id}/workflows/enrich-emails
Enrich Campaign Phones
POST/v1/campaigns/{campaign_id}/workflows/enrich-phones
Send Kickoff Kit
POST/v1/campaigns/{campaign_id}/workflows/send-kickoff-kit
Campaign Creators
List Campaign Creators
GET/v1/campaigns/{campaign_id}/creators
Add Campaign Creators
POST/v1/campaigns/{campaign_id}/creators
Add Campaign Creators Bulk
POST/v1/campaigns/{campaign_id}/creators/bulk
Add Campaign Creators From Collections
POST/v1/campaigns/{campaign_id}/creators/from-collections
Update Campaign Creator
PATCH/v1/campaign-creators/{campaign_creator_id}
Delete Campaign Creator
DELETE/v1/campaign-creators/{campaign_creator_id}
Transition Campaign Creator Route
POST/v1/campaign-creators/{campaign_creator_id}/transition
Enrich Campaign Creator Contacts
POST/v1/campaign-creators/contacts/enrich
Invite Campaign Creator
POST/v1/campaign-creators/{campaign_creator_id}/invite
Accept Campaign Creator
POST/v1/campaign-creators/{campaign_creator_id}/accept
Decline Campaign Creator
POST/v1/campaign-creators/{campaign_creator_id}/decline
Set Campaign Creator Contact Email
POST/v1/campaign-creators/{campaign_creator_id}/contact-email
Set Contact Email By Creator
POST/v1/campaign-creators/contact-email-by-creator
Bulk Delete Campaign Creators
POST/v1/campaign-creators/bulk-delete
Public Campaign Invites
Resolve Campaign Invite
GET/v1/public/campaign-invites/{token}
Mark Campaign Invite Viewed
POST/v1/public/campaign-invites/{token}/viewed
Accept Campaign Invite
POST/v1/public/campaign-invites/{token}/accept
Decline Campaign Invite
POST/v1/public/campaign-invites/{token}/decline
Contacts
List Contacts
GET/v1/contacts
Create Contact
POST/v1/contacts
Enrich Contacts
POST/v1/contacts/enrich
Get Contact
GET/v1/contacts/{contact_id}
Patch Contact
PATCH/v1/contacts/{contact_id}
Collections
List Collections
GET/v1/collections
Create Collection
POST/v1/collections
Get Collection
GET/v1/collections/{collection_id}
Patch Collection
PATCH/v1/collections/{collection_id}
Delete Collection
DELETE/v1/collections/{collection_id}
Bulk Delete Collections
POST/v1/collections/bulk-delete
CollectionsCreators
List Collection Creators
GET/v1/collections/{collection_id}/creators
Add Collection Creator
POST/v1/collections/{collection_id}/creators
Add Collection Creators Bulk
POST/v1/collections/{collection_id}/creators/bulk
Bulk Delete Collection Creators
POST/v1/collections/{collection_id}/creators/bulk-delete
Delete Collection Creator
DELETE/v1/collections/{collection_id}/creators/{collection_creator_id}
CollectionsContacts
Enrich Collection Contacts
POST/v1/collections/{collection_id}/contacts/enrich
Threads
List Threads
GET/v1/threads
Create Thread
POST/v1/threads
Get Thread
GET/v1/threads/{thread_id}
Patch Thread
PATCH/v1/threads/{thread_id}
Sync Thread
POST/v1/threads/{thread_id}/workflows/sync
Send Thread Message
POST/v1/threads/{thread_id}/workflows/send-message
ThreadsMessages
List Thread Messages
GET/v1/threads/{thread_id}/messages
Append Messages
POST/v1/threads/{thread_id}/messages
ThreadsChannel Bindings
List Thread Channel Bindings
GET/v1/threads/{thread_id}/channel-bindings
Create Thread Channel Binding
POST/v1/threads/{thread_id}/channel-bindings
Channel Connections
List Channel Connections
GET/v1/channel-connections
Create Channel Connection
POST/v1/channel-connections
Patch Channel Connection
PATCH/v1/channel-connections/{channel_connection_id}
Validate Channel Connection
POST/v1/channel-connections/{channel_connection_id}/validate
Disconnect Channel Connection
POST/v1/channel-connections/{channel_connection_id}/disconnect
Delete Channel Connection
DELETE/v1/channel-connections/{channel_connection_id}
Integrations
IntegrationsGmail
Gmail Auth Url
POST/v1/integrations/gmail/auth-url
Gmail Exchange
POST/v1/integrations/gmail/exchange
Gmail Disconnect
POST/v1/integrations/gmail/disconnect
IntegrationsComposio
Composio Auth Url
POST/v1/integrations/composio/{toolkit}/auth-url
Composio Finalize
POST/v1/integrations/composio/{toolkit}/finalize/{channel_connection_id}
Message Templates
List Message Templates
GET/v1/message-templates
Create Message Template
POST/v1/message-templates
Get Message Template
GET/v1/message-templates/{message_template_id}
Patch Message Template
PATCH/v1/message-templates/{message_template_id}
Delete Message Template
DELETE/v1/message-templates/{message_template_id}
Duplicate Message Template
POST/v1/message-templates/{message_template_id}/duplicate
Generated Message Templates
Create Generated Message Template
POST/v1/generated-message-templates
Mcp OAuth
Authorize Mcp Client
POST/v1/mcp/oauth/authorize
Token
POST/v1/mcp/oauth/token
Proposals
List Proposals
GET/v1/proposals
Create Proposal
POST/v1/proposals
Get Proposal
GET/v1/proposals/{proposal_id}
Patch Proposal
PATCH/v1/proposals/{proposal_id}
Send Proposal
POST/v1/proposals/{proposal_id}/send
Decide Proposal
POST/v1/proposals/{proposal_id}/decide
Accept Proposal
POST/v1/proposals/{proposal_id}/accept
Decline Proposal
POST/v1/proposals/{proposal_id}/decline
Contracts
List Contracts
GET/v1/contracts
Create Contract
POST/v1/contracts
Get Contract
GET/v1/contracts/{contract_id}
Patch Contract
PATCH/v1/contracts/{contract_id}
Send Contract
POST/v1/contracts/{contract_id}/send
Transition Contract Route
POST/v1/contracts/{contract_id}/transition
Void Contract
POST/v1/contracts/{contract_id}/void
ContractsRecipients
List Contract Recipients
GET/v1/contracts/{contract_id}/recipients
Add Contract Recipient
POST/v1/contracts/{contract_id}/recipients
ContractsArtifacts
List Contract Artifacts
GET/v1/contracts/{contract_id}/artifacts
Register Contract Artifact
POST/v1/contracts/{contract_id}/artifacts
Public Contracts
Resolve Contract Sign Token
GET/v1/public/contracts/{token}
Sign Contract
POST/v1/public/contracts/{token}/sign
Decline Contract
POST/v1/public/contracts/{token}/decline
Deals
List Deals
GET/v1/deals
Create Deal
POST/v1/deals
Get Deal
GET/v1/deals/{deal_id}
Patch Deal
PATCH/v1/deals/{deal_id}
Complete Deal
POST/v1/deals/{deal_id}/complete
Cancel Deal
POST/v1/deals/{deal_id}/cancel
Deliverables
List Deliverables
GET/v1/deliverables
Create Deliverables
POST/v1/deliverables
Get Deliverable
GET/v1/deliverables/{deliverable_id}
Patch Deliverable
PATCH/v1/deliverables/{deliverable_id}
Submit Deliverable
POST/v1/deliverables/{deliverable_id}/submit
Decide Deliverable
POST/v1/deliverables/{deliverable_id}/decide
Request Deliverable Changes
POST/v1/deliverables/{deliverable_id}/request-changes
Approve Deliverable
POST/v1/deliverables/{deliverable_id}/approve
List Deliverable Submissions
GET/v1/deliverables/{deliverable_id}/submissions
Content Submissions
Revise Content Submission
POST/v1/content-submissions/{submission_id}/revise
Decide Content Submission
POST/v1/content-submissions/{submission_id}/decide
Bulk Decide Content Submissions
POST/v1/content-submissions/bulk-decide
Content Reviews
List Content Reviews
GET/v1/content-reviews
Tracking Links
List Tracking Links
GET/v1/tracking-links
Create Tracking Link
POST/v1/tracking-links
Bulk Create Tracking Links
POST/v1/tracking-links/bulk-create
Get Tracking Link
GET/v1/tracking-links/{tracking_link_id}
Patch Tracking Link
PATCH/v1/tracking-links/{tracking_link_id}
Invoices
List Invoices
GET/v1/invoices
Create Invoice
POST/v1/invoices
Patch Invoice
PATCH/v1/invoices/{invoice_id}
Settle Invoice
POST/v1/invoices/{invoice_id}/settle
Bulk Settle Invoices
POST/v1/invoices/bulk-settle
Payments
List Payments
GET/v1/payments
Create Payment
POST/v1/payments
Patch Payment
PATCH/v1/payments/{payment_id}
Payment Obligations
List Payment Obligations
GET/v1/payment-obligations
Create Payment Obligation
POST/v1/payment-obligations
Workflow Runs
Get Workflow Run
GET/v1/workflows/{workflow_run_id}
Creator Portal
List My Campaigns
GET/v1/me/campaigns
Get My Campaign
GET/v1/me/campaigns/{campaign_id}
Get My Campaign Journey
GET/v1/me/campaigns/{campaign_id}/journey
Accept Invite Action
POST/v1/me/campaigns/{campaign_id}/actions/accept-invite
Decline Invite Action
POST/v1/me/campaigns/{campaign_id}/actions/decline-invite
Accept Proposal Action
POST/v1/me/campaigns/{campaign_id}/proposal/accept
Counter Proposal Action
POST/v1/me/campaigns/{campaign_id}/proposal/counter
Decline Proposal Action
POST/v1/me/campaigns/{campaign_id}/proposal/decline
Acknowledge Brief Action
POST/v1/me/campaigns/{campaign_id}/acknowledge-brief
Get My Deliverable
GET/v1/me/deliverables/{deliverable_id}
Submit My Deliverable
POST/v1/me/deliverables/{deliverable_id}/submit
Mark My Deliverable Live
POST/v1/me/deliverables/{deliverable_id}/mark-live
Revise My Content Submission
POST/v1/me/content-submissions/{submission_id}/revise
Claim Invite
POST/v1/me/claim-invite
Get My Profile
GET/v1/me/profile
Update My Profile
PATCH/v1/me/profile
Get My Onboarding State
GET/v1/me/onboarding-state
Complete My Onboarding
POST/v1/me/onboarding/complete
Sign Contract As Creator
POST/v1/me/contracts/{contract_id}/sign
Decline Contract As Creator
POST/v1/me/contracts/{contract_id}/decline
List My Threads
GET/v1/me/threads
List My Thread Messages
GET/v1/me/threads/{thread_id}/messages
Send My Thread Message
POST/v1/me/threads/{thread_id}/messages
Get My Rate Card
GET/v1/me/rate-card
Update My Rate Card
PATCH/v1/me/rate-card
Get My Gmail Connection
GET/v1/me/gmail/connection
Get My Gmail Auth Url
POST/v1/me/gmail/auth-url
Disconnect My Gmail
POST/v1/me/gmail/disconnect
Creator Composio Auth Url
POST/v1/me/integrations/composio/{toolkit}/auth-url
Creator Composio Finalize
POST/v1/me/integrations/composio/{toolkit}/finalize/{channel_connection_id}
Health
Health
GET/v1/health
Dependency Health
GET/v1/health/dependencies