API reference

Account & keys

• POST /v1/workspaces Create a workspace
• POST /v1/workspaces/verify Confirm a signup email
• GET /v1/workspace Get the current workspace and key
• PATCH /v1/workspace Set the low-balance alert
• GET /v1/api-keys List API keys
• POST /v1/api-keys Create an API key
• DELETE /v1/api-keys/{key_id} Revoke an API key

Billing & credits

• GET /v1/billing/plans List plans and credit rules
• GET /v1/billing/balance Get the credit balance
• GET /v1/usage Get credit usage
• POST /v1/billing/checkout Start a credit pack checkout
• POST /v1/billing/subscriptions Start a subscription checkout
• POST /v1/billing/subscription/plan Change the subscription plan
• GET /v1/billing/auto-refill Get auto-refill
• PUT /v1/billing/auto-refill Enable or update auto-refill
• DELETE /v1/billing/auto-refill Turn auto-refill off

Sourcing

Search, lookups, profiles, and companies.

• GET /v1/lookups/locations Find location ids
• GET /v1/lookups/areas Find the location ids around anchor places
• GET /v1/lookups/industries List industries
• GET /v1/lookups/seniorities List seniority levels
• GET /v1/lookups/experience-ranges List experience ranges
• GET /v1/lookups/functions List job functions
• GET /v1/lookups/languages List profile languages
• GET /v1/lookups/headcounts List company size ranges
• POST /v1/people/search Search people
• GET /v1/people/{profile_id} Get a person from your cache
• DELETE /v1/people/{profile_id} Erase a person from this workspace
• POST /v1/people:fetch Fetch full profiles
• POST /v1/people:match Find one person by name and current company
• GET /v1/jobs List profile fetch jobs
• GET /v1/jobs/{job_id} Get a job
• GET /v1/lookups/companies Search known companies
• POST /v1/companies:resolve Resolve company names to company URLs

Contacts

• GET /v1/people/{profile_id}/contacts Get stored contact details
• POST /v1/people/{profile_id}/contacts Look up personal email and phone
• DELETE /v1/people/{profile_id}/contacts Delete stored contact details
• POST /v1/people/contacts:fetch Look up contact details for many people

Lists & exports

• GET /v1/seen List the seen register
• POST /v1/seen Add or update seen entries
• POST /v1/seen:check Check people against the seen register
• GET /v1/seen/{seen_id} Get a seen entry
• PATCH /v1/seen/{seen_id} Update a seen entry
• DELETE /v1/seen/{seen_id} Remove a seen entry
• GET /v1/lists List candidate lists
• POST /v1/lists Create a candidate list
• GET /v1/lists/{list_id} Get a list
• PATCH /v1/lists/{list_id} Rename or describe a list
• DELETE /v1/lists/{list_id} Delete a list
• GET /v1/lists/{list_id}/items List the people on a list
• POST /v1/lists/{list_id}/items Add people to a list
• DELETE /v1/lists/{list_id}/items/{item_id} Remove a person from a list
• GET /v1/lists/{list_id}/export Export a list as CSV

Outreach

• GET /v1/outreach/settings Get outreach settings
• PATCH /v1/outreach/settings Update outreach settings
• GET /v1/outreach/templates List sequence templates
• POST /v1/outreach/accounts Connect a LinkedIn account
• GET /v1/outreach/accounts List outreach accounts
• GET /v1/outreach/accounts/{account_id} Get an outreach account
• DELETE /v1/outreach/accounts/{account_id} Disconnect an outreach account
• GET /v1/outreach/accounts/{account_id}/limits Get today's limits for an account
• PATCH /v1/outreach/accounts/{account_id}/limits Change an account's caps
• GET /v1/outreach/sequences List sequences
• POST /v1/outreach/sequences Create a sequence
• GET /v1/outreach/sequences/{sequence_id} Get a sequence
• PATCH /v1/outreach/sequences/{sequence_id} Update a sequence
• DELETE /v1/outreach/sequences/{sequence_id} Delete a sequence
• GET /v1/outreach/enrollments List enrollments
• POST /v1/outreach/enrollments Enroll people in a sequence
• GET /v1/outreach/enrollments/{enrollment_id} Get an enrollment
• POST /v1/outreach/enrollments/{enrollment_id}/pause Pause an enrollment
• POST /v1/outreach/enrollments/{enrollment_id}/resume Resume an enrollment
• POST /v1/outreach/enrollments/{enrollment_id}/stop Stop an enrollment
• GET /v1/outreach/actions List outreach actions
• GET /v1/outreach/actions/{action_id} Get an outreach action
• POST /v1/outreach/actions/{action_id}/approve Approve a held message
• POST /v1/outreach/sends Send one LinkedIn action
• GET /v1/outreach/conversations List conversations
• GET /v1/outreach/conversations/{conversation_id} Get a conversation with its messages
• POST /v1/outreach/conversations/{conversation_id}/replies Reply in a conversation

Privacy/opt-out

• POST /v1/erasures Erase a person and suppress them
• GET /v1/suppressions List suppressions
• POST /v1/suppressions Suppress a person
• DELETE /v1/suppressions/{suppression_id} Lift a suppression
• DELETE /v1/privacy/cache Delete cached profiles, pages, and contact details
• POST /v1/privacy/opt-out Opt out (for the person themselves)
• GET /v1/privacy/opt-out/confirm Confirm an opt-out

Customers

• GET /v1/customers List customers
• POST /v1/customers Create a customer
• GET /v1/customers/{customer_id} Get a customer
• PATCH /v1/customers/{customer_id} Update a customer
• DELETE /v1/customers/{customer_id} Delete a customer and its data

Events

• GET /v1/events List events
• GET /v1/events/{event_id} Get an event
• GET /v1/webhook-endpoints List webhook endpoints
• POST /v1/webhook-endpoints Add a webhook endpoint
• GET /v1/webhook-endpoints/{endpoint_id} Get a webhook endpoint
• PATCH /v1/webhook-endpoints/{endpoint_id} Update a webhook endpoint
• DELETE /v1/webhook-endpoints/{endpoint_id} Delete a webhook endpoint
• POST /v1/webhook-endpoints/{endpoint_id}/rotate-secret Rotate an endpoint's signing secret
• POST /v1/webhook-endpoints/{endpoint_id}/test Send a test event