Reference · 134 operations
API reference
Generated from the live OpenAPI document. Each group page lists its operations with scope, price, parameters, schemas and examples.
Last updated from API version 2026-10-06 at (live spec, refreshed hourly). openapi.json
Meta
3 operationsDiscovery and health. No key needed.
Me
2 operationsThe calling key and its workspace.
Contacts
3 operationsPeople in the workspace.
Companies
3 operationsCompanies in the workspace.
Sequences
5 operationsOutreach sequences, their enrollments and reply reports.
- get
/sequencesList outreach sequences, newest first. - get
/sequences/{id}Get one sequence with its steps, assigned identity and live counts. - get
/sequences/{id}/enrollmentsList a sequence's enrollments, newest first. - get
/sequences/{id}/analyticsGet a sequence's enrollment funnel and lifecycle counts. - get
/sequences/{id}/repliesReport a sequence's campaign-attributable replies over a date range.
Identities
1 operationsThe workspace's sending identities.
Tables
37 operationsData tables in the workspace, their typed columns and rows.
- get
/tablesList data tables, newest first. - post
/tablesCreate a table, optionally with typed columns. - get
/tables/{id}Get one table with its typed columns and views. - patch
/tables/{id}Rename a table or change its description. - delete
/tables/{id}Archive a table. - get
/tables/{id}/columnsList a table's columns by position. - post
/tables/{id}/columnsAdd a column. - post
/tables/{id}/columns/reorderSet the column order. - patch
/tables/{id}/columns/{columnId}Rename, reconfigure, hide, resize or move a column. - delete
/tables/{id}/columns/{columnId}Delete a column and its values. - get
/tables/{id}/rowsList a table's rows: newest first, filtered, sorted or changed since a version. - post
/tables/{id}/rowsInsert or update up to 5,000 rows (500 on some workspaces: more is 422 LIMIT_EXCEEDED). - patch
/tables/{id}/rowsSet the same cells on many rows. - post
/tables/{id}/rows/deleteDelete many rows. - post
/tables/{id}/rows/pushPush rows to contacts, a sequence or a CRM. - get
/tables/{id}/rows/{rowId}Get one row with its version. - patch
/tables/{id}/rows/{rowId}Update a row's cells, optionally only if unchanged (If-Match). - delete
/tables/{id}/rows/{rowId}Delete a row, optionally only if unchanged (If-Match). - get
/tables/{id}/rows/{rowId}/historyA row's history, newest first. - post
/tables/{id}/importsImport an uploaded CSV file into the table (runs in the background). - post
/tables/{id}/imports/upload-urlRegister a CSV upload and get a one-hour upload URL. - post
/tables/{id}/imports/previewPreview an uploaded CSV: format, suggested mapping, sample rows, dedupe stats. - get
/tables/{id}/imports/{importId}An import's status, progress, counts and row errors. - post
/tables/{id}/exportsExport the table, a view or a filtered selection as CSV, JSON Lines or JSON. - get
/tables/{id}/exports/{exportId}An export's status and, when done, its download link (24 h). - get
/tables/{id}/viewsList a table's views. - post
/tables/{id}/viewsSave a view: a filter, sorts, hidden columns and a column order. - patch
/tables/{id}/views/{viewId}Change a view. - delete
/tables/{id}/views/{viewId}Delete a view. - get
/tables/{id}/action-logThe table's action log, newest first. - post
/tables/{id}/columns/{columnId}/runs/estimateEstimate a column run (free, nothing held). - post
/tables/{id}/columns/{columnId}/runsRun a column (formula, ai, enrichment or action). - get
/tables/{id}/runsThe table's column runs, newest first. - get
/tables/{id}/runs/{runId}One column run. - get
/tables/{id}/runs/{runId}/cellsThe run's cells: per-cell status, attempts and charge. - post
/tables/{id}/runs/{runId}/cancelCancel a run. - post
/tables/{id}/rows/{rowId}/cells/{columnId}/retryRun one cell again.
Credits
3 operationsThe workspace's credit wallet, its ledger and the price list.
Actions
66 operationsEvery capability as one operation
actions.<family>.<verb>: one target
model, dry run, lifecycle and audit (the catalog is GET /action-types).
- get
/action-typesThe action catalog: every actions.* operation. - get
/action-types/{operationId}One action operation of the catalog. - get
/actionsList the workspace's actions, newest first. - get
/actions/{id}Get one action, optionally waiting for it to finish. - get
/actions/{id}/targetsThe action's targets and their outcomes. - get
/actions/{id}/auditThe action's per-target audit trail, newest first. - post
/actions/{id}/cancelCancel an action's targets that have not started. - post
/actions/find/provider_idResolve a LinkedIn profile URL to its provider id. - post
/actions/lists/sales_navA list of people from a Sales Navigator URL. - post
/actions/lists/linkedin_searchA list of people from LinkedIn search criteria. - post
/actions/lists/icpScrape a saved audience (ICP) into its contacts. - post
/actions/lists/companiesA list of companies from a LinkedIn company search. - post
/actions/lists/company_employeesA list of one company's employees. - post
/actions/lists/decision_makersA list of one company's decision makers. - post
/actions/lists/post_engagersA list of the people who engaged with a LinkedIn post. - post
/actions/lists/website_visitorsA list of the companies that visited the website. - post
/actions/lists/createBuild a list from any list source. - post
/actions/find/linkedin_urlFind a person's LinkedIn profile URL. - post
/actions/find/public_urlResolve a Sales Navigator profile URL to its public LinkedIn URL. - post
/actions/find/company_idsFind LinkedIn company ids for a company name. - post
/actions/crm/hubspot/upsert_contactCreate or update HubSpot contacts (fill empty fields, never delete). - post
/actions/crm/hubspot/upsert_companyCreate or update the HubSpot companies of contacts (fill empty fields, never delete). - post
/actions/crm/hubspot/enroll_sequenceEnroll contacts in a HubSpot sequence. - post
/actions/crm/emailbison/send_emailSend an email to each contact through EmailBison. - post
/actions/http/callCall your own HTTP endpoint once per contact. - post
/actions/email/sendSend an email to each contact from the identity's mailbox. - post
/actions/whatsapp/sendSend a WhatsApp message to each contact. - post
/actions/notify/slackPost a Slack message about each contact. - post
/actions/notify/google_chatPost a Google Chat message about each contact. - post
/actions/sequences/enrollEnroll contacts into an existing sequence (reviewed by a person first). - post
/actions/plays/triggerStart a deployed play for contacts (reviewed by a person first). - post
/actions/contacts/tagAdd tags to contacts. - post
/actions/contacts/untagRemove tags from contacts. - post
/actions/contacts/set_statusSet contacts' status. - post
/actions/contacts/assign_ownerAssign contacts to an owner identity. - post
/actions/contacts/set_fieldsSet contact fields (fill empty by default). - post
/actions/contacts/link_icpLink contacts to an audience (ICP). - post
/actions/contacts/archiveArchive contacts (soft). - post
/actions/sequences/pausePause contacts' enrollments in a sequence. - post
/actions/sequences/stopStop contacts' enrollments in a sequence. - post
/actions/sequences/resumeResume paused enrollments in a sequence (reviewed by a person first). - post
/actions/linkedin/connectSend a LinkedIn invitation to each contact. - post
/actions/linkedin/dmSend a LinkedIn message to each contact. - post
/actions/linkedin/inmailSend a LinkedIn InMail to each contact. - post
/actions/linkedin/view_profileView each contact's LinkedIn profile. - post
/actions/linkedin/followFollow each contact on LinkedIn. - post
/actions/linkedin/unfollowUnfollow each contact on LinkedIn. - post
/actions/linkedin/likeLike a post of each contact. - post
/actions/linkedin/commentComment on a post of each contact. - post
/actions/linkedin/repostRepost a contact's post. - post
/actions/linkedin/reply_commentReply to a contact's comment on a post. - post
/actions/linkedin/endorseEndorse a skill of each contact. - post
/actions/linkedin/withdrawWithdraw the pending invitation to each contact. - post
/actions/linkedin/post_createPublish a post on the identity's LinkedIn feed. - post
/actions/linkedin/check_connectionCheck each contact's connection with the identity. - post
/actions/linkedin/check_replyCheck whether each contact replied on LinkedIn. - post
/actions/score/contactScore a contact against an ICP with AI. - post
/actions/enrich/work_emailFind a person's work email. - post
/actions/enrich/mobile_phoneFind a person's mobile phone. - post
/actions/ai/generate_messageWrite a personalized message for a contact with AI. - post
/actions/ai/icebreakerWrite an icebreaker for a contact with AI. - post
/actions/ai/subjectWrite an email subject line for a contact with AI. - post
/actions/research/webSearch the web. - post
/actions/research/read_pageRead a public web page. - post
/actions/research/company_websiteResearch a company from its website. - post
/actions/research/company_newsFind recent news about a company.
Events
1 operationsThe workspace's event feed (action started, target outcomes, action
completed), oldest first, with a cursor to poll for newer events.
Webhooks
8 operationsSigned deliveries of the event feed to your own endpoints, retried
for 24 hours. A convenience:
GET /events is the source of truth.
- get
/webhook-endpointsThe workspace's webhook endpoints, newest first. - post
/webhook-endpointsAdd a webhook endpoint; the signing secret is in this answer only. - get
/webhook-endpoints/{id}One webhook endpoint (without its secret). - patch
/webhook-endpoints/{id}Change an endpoint's url, events, description or status. - delete
/webhook-endpoints/{id}Delete an endpoint; its queued deliveries are canceled. - post
/webhook-endpoints/{id}/rotate-secretMake a new signing secret; the previous one keeps signing for 24 hours. - get
/webhook-endpoints/{id}/deliveriesAn endpoint's deliveries, newest first (kept 7 days). - post
/webhook-endpoints/{id}/deliveries/{deliveryId}/redeliverSend a delivery's event again.
Approvals
2 operationsActions waiting for a person. Read only: a person approves or
rejects in the app, with a fresh sign-in; no key, agent or API call
can approve anything.