{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Quick Start","link":"/","routeSlug":"/","relativePathFromDirectory":"index.md"},{"type":"link","fsPath":"KNOWN_ISSUES.md","metadata":{"type":"markdown"},"label":"Known issues & workarounds","link":"/known_issues","routeSlug":"/known_issues","relativePathFromDirectory":"KNOWN_ISSUES.md"},{"type":"link","label":"Grinfi.io API","link":"/openapi","routeSlug":"/openapi"},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication"},{"type":"link","label":"Pagination","link":"/openapi/section/pagination","routeSlug":"/openapi/section/pagination"},{"type":"link","label":"Filtering","link":"/openapi/section/filtering","routeSlug":"/openapi/section/filtering"},{"type":"link","label":"Rate Limits","link":"/openapi/section/rate-limits","routeSlug":"/openapi/section/rate-limits"},{"type":"link","label":"Contact Deduplication","link":"/openapi/section/contact-deduplication","routeSlug":"/openapi/section/contact-deduplication"},{"type":"separator","label":"Account"},{"type":"group","label":"User","link":"/openapi/user","routeSlug":"/openapi/user","items":[{"label":"Get current user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/getcurrentuser","routeSlug":"/openapi/user/getcurrentuser","metadata":{"seo":{"title":"Get current user","description":"Retrieve the authenticated user's profile and configuration."}},"httpPath":"/id/api/users/current"}]},{"type":"group","label":"Teams","link":"/openapi/teams","routeSlug":"/openapi/teams","items":[{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/teams/listteams","routeSlug":"/openapi/teams/listteams","metadata":{"seo":{"title":"List teams","description":"List all teams (workspaces) the authenticated user has access to."}},"httpPath":"/id/api/teams"},{"label":"Get a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/teams/getteam","routeSlug":"/openapi/teams/getteam","metadata":{"seo":{"title":"Get a team","description":"Get details of a specific team by ID."}},"httpPath":"/id/api/teams/{id}"},{"label":"Check sender profile capacity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/teams/checkteamlimits","routeSlug":"/openapi/teams/checkteamlimits","metadata":{"seo":{"title":"Check sender profile capacity","description":"Check whether the team has capacity for the requested number of additional sender profiles within its current subscription limits. Returns monthly and yearly usage information (or null for each if the team has no active subscription on that cycle)."}},"httpPath":"/id/api/teams/{id}/check-limits"}]},{"type":"group","label":"API Keys","link":"/openapi/api-keys","routeSlug":"/openapi/api-keys","items":[{"label":"Create an API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api-keys/createapikey","routeSlug":"/openapi/api-keys/createapikey","metadata":{"seo":{"title":"Create an API key","description":"Create a new API key bound to your current team. The returned last_token is the actual JWT to use in the Authorization: Bearer <token> header on subsequent requests. Tokens have a 3-year expiry."}},"httpPath":"/id/api/jwt-tokens/create-api-key"}]},{"type":"separator","label":"CRM"},{"type":"group","label":"Contacts","link":"/openapi/contacts","routeSlug":"/openapi/contacts","items":[{"label":"Find a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/findonecontact","routeSlug":"/openapi/contacts/findonecontact","metadata":{"seo":{"title":"Find a contact","description":"Look up a single contact by LinkedIn ID, email address, or name + company combination. At least one identifier must be provided. This is useful for checking if a contact already exists before creating a new one."}},"httpPath":"/leads/api/leads/lookup-one"},{"label":"Search contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/searchcontacts","routeSlug":"/openapi/contacts/searchcontacts","metadata":{"seo":{"title":"Search contacts","description":"Search contacts using advanced filters with pagination and sorting. Use this to find contacts by any combination of fields — name, company, email status, pipeline stage, tags, and more."}},"httpPath":"/leads/api/leads/search"},{"label":"Get a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/getlead","routeSlug":"/openapi/contacts/getlead","metadata":{"seo":{"title":"Get a contact","description":"Retrieve full details of a contact by their UUID."}},"httpPath":"/leads/api/leads/{uuid}"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/updatelead","routeSlug":"/openapi/contacts/updatelead","metadata":{"seo":{"title":"Update a contact","description":"Update one or more fields on an existing contact. Only include the fields you want to change."}},"httpPath":"/leads/api/leads/{uuid}"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/deletelead","routeSlug":"/openapi/contacts/deletelead","metadata":{"seo":{"title":"Delete a contact","description":"Permanently delete a contact by UUID. This creates a background deletion job."}},"httpPath":"/leads/api/leads/{uuid}"},{"label":"Create or update a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/upsertcontact","routeSlug":"/openapi/contacts/upsertcontact","metadata":{"seo":{"title":"Create or update a contact","description":"Create a new contact in a list, or update an existing one if found. The contact is identified by linkedin_id. If the contact already exists and update_if_exists is true, their data will be updated. Optionally move the contact to the specified list with move_to_list."}},"httpPath":"/leads/api/leads/upsert"},{"label":"Mass action on contacts","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/leadsmassaction","routeSlug":"/openapi/contacts/leadsmassaction","metadata":{"seo":{"title":"Mass action on contacts","description":"Perform a bulk action on contacts matching a filter."}},"httpPath":"/leads/api/leads/mass-action"},{"label":"Count contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/countcontacts","routeSlug":"/openapi/contacts/countcontacts","metadata":{"seo":{"title":"Count contacts","description":"Count contacts matching a filter without returning the full data. Use all: true to count every contact in the team, or pass an explicit list of contact UUIDs in ids (with all: false) to count a specific subset."}},"httpPath":"/leads/api/leads/count"},{"label":"Get team-wide engagement metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/getleadmetrics","routeSlug":"/openapi/contacts/getleadmetrics","metadata":{"seo":{"title":"Get team-wide engagement metrics","description":"Returns aggregated outreach metrics across the whole team for the requested period."}},"httpPath":"/leads/api/leads/metrics"},{"label":"Run advanced enrichment on contacts","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/enrichleadsadvanced","routeSlug":"/openapi/contacts/enrichleadsadvanced","metadata":{"seo":{"title":"Run advanced enrichment on contacts","description":"Enqueue advanced LinkedIn enrichment on a set of contacts. Enrichment consumes credits — returns 402 Payment Required if your team has insufficient balance."}},"httpPath":"/leads/api/leads/advanced-enrichment"},{"label":"List enrichment queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/listenrichmentqueue","routeSlug":"/openapi/contacts/listenrichmentqueue","metadata":{"seo":{"title":"List enrichment queue","description":"List entries in the enrichment processing queue."}},"httpPath":"/leads/api/enrichment-queue"},{"label":"Get enrichment usage metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/getenrichmentmetrics","routeSlug":"/openapi/contacts/getenrichmentmetrics","metadata":{"seo":{"title":"Get enrichment usage metrics","description":"Return aggregate metrics about enrichment activity for the team — currently the count of enrichment jobs queued/processed in the current calendar month."}},"httpPath":"/leads/api/enrichment-queue/metrics"}]},{"type":"group","label":"Companies","link":"/openapi/companies","routeSlug":"/openapi/companies","items":[{"label":"List companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/listcompanies","routeSlug":"/openapi/companies/listcompanies","metadata":{"seo":{"title":"List companies","description":"Retrieve a paginated list of companies in your CRM. Supports filtering by name, domain, industry, and other fields."}},"httpPath":"/leads/api/companies"},{"label":"Create companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/createcompanies","routeSlug":"/openapi/companies/createcompanies","metadata":{"seo":{"title":"Create companies","description":"Create one or more company records. Optionally assign them to lists and a data source."}},"httpPath":"/leads/api/companies"},{"label":"Get a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/getcompany","routeSlug":"/openapi/companies/getcompany","metadata":{"seo":{"title":"Get a company","description":"Retrieve full details of a company by UUID."}},"httpPath":"/leads/api/companies/{uuid}"},{"label":"Update a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/updatecompany","routeSlug":"/openapi/companies/updatecompany","metadata":{"seo":{"title":"Update a company","description":"Update one or more fields on an existing company."}},"httpPath":"/leads/api/companies/{uuid}"},{"label":"Delete a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/deletecompany","routeSlug":"/openapi/companies/deletecompany","metadata":{"seo":{"title":"Delete a company","description":"Permanently delete a company by UUID."}},"httpPath":"/leads/api/companies/{uuid}"},{"label":"Search companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/searchcompanies","routeSlug":"/openapi/companies/searchcompanies","metadata":{"seo":{"title":"Search companies","description":"Search and filter companies with pagination. Same filtering capabilities as GET /leads/api/companies but as a POST so you can pass complex filter objects in the request body instead of query strings."}},"httpPath":"/leads/api/companies/list"},{"label":"Lookup companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/lookupcompanies","routeSlug":"/openapi/companies/lookupcompanies","metadata":{"seo":{"title":"Lookup companies","description":"Find companies by LinkedIn ID, website URL, or name. Pass an array of lookup criteria — each item should contain at least one identifier."}},"httpPath":"/leads/api/companies/lookup"},{"label":"Get contacts by companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/getcompanyleads","routeSlug":"/openapi/companies/getcompanyleads","metadata":{"seo":{"title":"Get contacts by companies","description":"Retrieve all contacts belonging to the specified companies. Returns an object mapping company UUIDs to arrays of contacts."}},"httpPath":"/leads/api/companies/leads"},{"label":"Enrich companies","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/enrichcompanies","routeSlug":"/openapi/companies/enrichcompanies","metadata":{"seo":{"title":"Enrich companies","description":"Queue advanced enrichment for companies. Provide either a filter to select companies or an array of specific company UUIDs. Enrichment uses credits from your account balance."}},"httpPath":"/leads/api/companies/advanced-enrichment"},{"label":"Mass action on companies","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/companiesmassaction","routeSlug":"/openapi/companies/companiesmassaction","metadata":{"seo":{"title":"Mass action on companies","description":"Perform a bulk action on companies matching a filter."}},"httpPath":"/leads/api/companies/mass-action"}]},{"type":"group","label":"Lists","link":"/openapi/lists","routeSlug":"/openapi/lists","items":[{"label":"List all lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/listlists","routeSlug":"/openapi/lists/listlists","metadata":{"seo":{"title":"List all lists","description":"Retrieve all contact lists in your account. Lists are used to organize contacts into groups for outreach campaigns."}},"httpPath":"/leads/api/lists"},{"label":"Create a list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/createlist","routeSlug":"/openapi/lists/createlist","metadata":{"seo":{"title":"Create a list","description":"Create a new contact list."}},"httpPath":"/leads/api/lists"},{"label":"Get a list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/getlist","routeSlug":"/openapi/lists/getlist","metadata":{"seo":{"title":"Get a list","description":"Retrieve details of a specific contact list."}},"httpPath":"/leads/api/lists/{uuid}"},{"label":"Update a list","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/updatelist","routeSlug":"/openapi/lists/updatelist","metadata":{"seo":{"title":"Update a list","description":"Rename an existing contact list."}},"httpPath":"/leads/api/lists/{uuid}"},{"label":"Delete a list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/deletelist","routeSlug":"/openapi/lists/deletelist","metadata":{"seo":{"title":"Delete a list","description":"Permanently delete a contact list."}},"httpPath":"/leads/api/lists/{uuid}"},{"label":"Get list metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/getlistmetrics","routeSlug":"/openapi/lists/getlistmetrics","metadata":{"seo":{"title":"Get list metrics","description":"Get lead counts for specified lists."}},"httpPath":"/leads/api/lists/metrics"}]},{"type":"group","label":"Tags","link":"/openapi/tags","routeSlug":"/openapi/tags","items":[{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/listtags","routeSlug":"/openapi/tags/listtags","metadata":{"seo":{"title":"List tags","description":"Retrieve all tags in your account."}},"httpPath":"/leads/api/tags"},{"label":"Create a tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/createtag","routeSlug":"/openapi/tags/createtag","metadata":{"seo":{"title":"Create a tag","description":"Create a new tag with optional color."}},"httpPath":"/leads/api/tags"},{"label":"Update a tag","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/updatetag","routeSlug":"/openapi/tags/updatetag","metadata":{"seo":{"title":"Update a tag","description":"Update a tag's name or color."}},"httpPath":"/leads/api/tags/{uuid}"},{"label":"Delete a tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/deletetag","routeSlug":"/openapi/tags/deletetag","metadata":{"seo":{"title":"Delete a tag","description":"Permanently delete a tag."}},"httpPath":"/leads/api/tags/{uuid}"},{"label":"Get tag metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/gettagmetrics","routeSlug":"/openapi/tags/gettagmetrics","metadata":{"seo":{"title":"Get tag metrics","description":"Get lead and company counts for specified tags."}},"httpPath":"/leads/api/tags/metrics"}]},{"type":"group","label":"Pipeline","link":"/openapi/pipeline","routeSlug":"/openapi/pipeline","items":[{"label":"List pipeline stages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipeline/listpipelinestages","routeSlug":"/openapi/pipeline/listpipelinestages","metadata":{"seo":{"title":"List pipeline stages","description":"Retrieve all pipeline stages. Use the filter parameter (JSON string) to narrow results by object type or stage type."}},"httpPath":"/leads/api/pipeline-stages"},{"label":"Create a pipeline stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipeline/createpipelinestage","routeSlug":"/openapi/pipeline/createpipelinestage","metadata":{"seo":{"title":"Create a pipeline stage","description":"Create a new custom pipeline stage."}},"httpPath":"/leads/api/pipeline-stages"},{"label":"Update a pipeline stage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipeline/updatepipelinestage","routeSlug":"/openapi/pipeline/updatepipelinestage","metadata":{"seo":{"title":"Update a pipeline stage","description":"Update a pipeline stage's name, category, or order."}},"httpPath":"/leads/api/pipeline-stages/{uuid}"},{"label":"Delete a pipeline stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipeline/deletepipelinestage","routeSlug":"/openapi/pipeline/deletepipelinestage","metadata":{"seo":{"title":"Delete a pipeline stage","description":"Delete a custom pipeline stage."}},"httpPath":"/leads/api/pipeline-stages/{uuid}"}]},{"type":"group","label":"Custom Fields","link":"/openapi/custom-fields","routeSlug":"/openapi/custom-fields","items":[{"label":"List custom fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/listcustomfields","routeSlug":"/openapi/custom-fields/listcustomfields","metadata":{"seo":{"title":"List custom fields","description":"Retrieve all custom field definitions for contacts and companies."}},"httpPath":"/leads/api/custom-fields"},{"label":"Create a custom field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/createcustomfield","routeSlug":"/openapi/custom-fields/createcustomfield","metadata":{"seo":{"title":"Create a custom field","description":"Define a new custom field for contacts or companies."}},"httpPath":"/leads/api/custom-fields"},{"label":"Update a custom field","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/updatecustomfield","routeSlug":"/openapi/custom-fields/updatecustomfield","metadata":{"seo":{"title":"Update a custom field","description":"Update a custom field's name or order."}},"httpPath":"/leads/api/custom-fields/{uuid}"},{"label":"Delete a custom field","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/deletecustomfield","routeSlug":"/openapi/custom-fields/deletecustomfield","metadata":{"seo":{"title":"Delete a custom field","description":"Permanently remove a custom field definition and all its values."}},"httpPath":"/leads/api/custom-fields/{uuid}"},{"label":"Set a custom field value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/upsertcustomfieldvalue","routeSlug":"/openapi/custom-fields/upsertcustomfieldvalue","metadata":{"seo":{"title":"Set a custom field value","description":"Set (or update) a custom field value on a contact or company. Pass null as value to clear the field."}},"httpPath":"/leads/api/custom-field-values"}]},{"type":"group","label":"Notes","link":"/openapi/notes","routeSlug":"/openapi/notes","items":[{"label":"List notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notes/listnotes","routeSlug":"/openapi/notes/listnotes","metadata":{"seo":{"title":"List notes","description":"Retrieve notes with pagination."}},"httpPath":"/leads/api/notes"},{"label":"Create a note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notes/createnote","routeSlug":"/openapi/notes/createnote","metadata":{"seo":{"title":"Create a note","description":"Add a note to a contact or company."}},"httpPath":"/leads/api/notes"},{"label":"Update a note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notes/updatenote","routeSlug":"/openapi/notes/updatenote","metadata":{"seo":{"title":"Update a note","description":"Update the text of an existing note."}},"httpPath":"/leads/api/notes/{uuid}"},{"label":"Delete a note","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notes/deletenote","routeSlug":"/openapi/notes/deletenote","metadata":{"seo":{"title":"Delete a note","description":"Permanently delete a note."}},"httpPath":"/leads/api/notes/{uuid}"}]},{"type":"group","label":"Activities","link":"/openapi/activities","routeSlug":"/openapi/activities","items":[{"label":"List activities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/activities/listactivities","routeSlug":"/openapi/activities/listactivities","metadata":{"seo":{"title":"List activities","description":"List activity records for contacts or companies. Activities track events like messages sent, emails opened, pipeline stage changes, and more."}},"httpPath":"/leads/api/activities"},{"label":"Create an activity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/activities/createactivity","routeSlug":"/openapi/activities/createactivity","metadata":{"seo":{"title":"Create an activity","description":"Create a new activity record for a contact or company."}},"httpPath":"/leads/api/activities"}]},{"type":"group","label":"Blacklist","link":"/openapi/blacklist","routeSlug":"/openapi/blacklist","items":[{"label":"List blacklisted contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/listleadsblacklist","routeSlug":"/openapi/blacklist/listleadsblacklist","metadata":{"seo":{"title":"List blacklisted contacts","description":"Returns blacklisted contact entries for the team. Blacklisted contacts are excluded from imports, enrichment, automations, and mass actions."}},"httpPath":"/leads/api/leads-blacklist"},{"label":"Add contact to blacklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/addleadtoblacklist","routeSlug":"/openapi/blacklist/addleadtoblacklist","metadata":{"seo":{"title":"Add contact to blacklist","description":"Blacklist a contact by LinkedIn handle, email, name, or company name. Provide at least one identifier; the entry is matched on import and outreach."}},"httpPath":"/leads/api/leads-blacklist"},{"label":"Remove contact from blacklist","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/deleteleadblacklistentry","routeSlug":"/openapi/blacklist/deleteleadblacklistentry","metadata":{"seo":{"title":"Remove contact from blacklist","description":"Delete a blacklist entry by its UUID."}},"httpPath":"/leads/api/leads-blacklist/{uuid}"},{"label":"List blacklisted companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/listcompaniesblacklist","routeSlug":"/openapi/blacklist/listcompaniesblacklist","metadata":{"seo":{"title":"List blacklisted companies","description":"Returns blacklisted company entries for the team. Blacklisted companies are excluded from imports, enrichment, automations, and mass actions."}},"httpPath":"/leads/api/companies-blacklist"},{"label":"Add company to blacklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/addcompanytoblacklist","routeSlug":"/openapi/blacklist/addcompanytoblacklist","metadata":{"seo":{"title":"Add company to blacklist","description":"Blacklist a company by LinkedIn handle, domain, or name. Provide at least one identifier; the entry is matched on import and outreach."}},"httpPath":"/leads/api/companies-blacklist"},{"label":"Remove company from blacklist","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/deletecompanyblacklistentry","routeSlug":"/openapi/blacklist/deletecompanyblacklistentry","metadata":{"seo":{"title":"Remove company from blacklist","description":"Delete a blacklist entry by its UUID."}},"httpPath":"/leads/api/companies-blacklist/{uuid}"}]},{"type":"group","label":"Data Sources","link":"/openapi/data-sources","routeSlug":"/openapi/data-sources","items":[{"label":"List data sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/listdatasources","routeSlug":"/openapi/data-sources/listdatasources","metadata":{"seo":{"title":"List data sources","description":"List LinkedIn import jobs with pagination."}},"httpPath":"/leads/api/data-sources"},{"label":"Create a data source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/createdatasource","routeSlug":"/openapi/data-sources/createdatasource","metadata":{"seo":{"title":"Create a data source","description":"Create a data source"}},"httpPath":"/leads/api/data-sources"},{"label":"Get a data source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/getdatasource","routeSlug":"/openapi/data-sources/getdatasource","metadata":{"seo":{"title":"Get a data source","description":"Get a data source"}},"httpPath":"/leads/api/data-sources/{uuid}"},{"label":"Update a data source","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/updatedatasource","routeSlug":"/openapi/data-sources/updatedatasource","metadata":{"seo":{"title":"Update a data source","description":"Update a data source"}},"httpPath":"/leads/api/data-sources/{uuid}"},{"label":"Delete a data source","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/deletedatasource","routeSlug":"/openapi/data-sources/deletedatasource","metadata":{"seo":{"title":"Delete a data source","description":"Delete a data source"}},"httpPath":"/leads/api/data-sources/{uuid}"},{"label":"Get data source metrics","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/getdatasourcemetrics","routeSlug":"/openapi/data-sources/getdatasourcemetrics","metadata":{"seo":{"title":"Get data source metrics","description":"Return per-data-source counts of queued, saved, duplicate, blacklisted, and error records. Pass an array of data source UUIDs in uuids. The response is a map keyed by UUID."}},"httpPath":"/leads/api/data-sources/metrics"}]},{"type":"group","label":"File Operations","link":"/openapi/file-operations","routeSlug":"/openapi/file-operations","items":[{"label":"Upload a CSV file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/uploadcsvfile","routeSlug":"/openapi/file-operations/uploadcsvfile","metadata":{"seo":{"title":"Upload a CSV file","description":"Upload a CSV file to be imported as contacts or companies. Returns a file-import record with a UUID. Pass that UUID to import-leads or import-companies to actually create the records."}},"httpPath":"/leads/api/file-imports/upload-csv"},{"label":"Import contacts from uploaded file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/importleadsfromfile","routeSlug":"/openapi/file-operations/importleadsfromfile","metadata":{"seo":{"title":"Import contacts from uploaded file","description":"Trigger contact import from a previously uploaded CSV file. Required field: columns — an ordered list of column-mapping objects describing how to map CSV columns to contact fields."}},"httpPath":"/leads/api/file-imports/{uuid}/import-leads"},{"label":"Import companies from uploaded file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/importcompaniesfromfile","routeSlug":"/openapi/file-operations/importcompaniesfromfile","metadata":{"seo":{"title":"Import companies from uploaded file","description":"Trigger company import from a previously uploaded CSV file."}},"httpPath":"/leads/api/file-imports/{uuid}/import-companies"},{"label":"Export contacts to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/exportleadstocsv","routeSlug":"/openapi/file-operations/exportleadstocsv","metadata":{"seo":{"title":"Export contacts to CSV","description":"Queue a CSV export of contacts matching the filter. Returns a file-export record with status queued. Once the job completes, use download to retrieve the file."}},"httpPath":"/leads/api/file-exports/leads"},{"label":"Export companies to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/exportcompaniestocsv","routeSlug":"/openapi/file-operations/exportcompaniestocsv","metadata":{"seo":{"title":"Export companies to CSV","description":"Queue a CSV export of companies matching the filter."}},"httpPath":"/leads/api/file-exports/companies"},{"label":"Download an exported file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/downloadexportfile","routeSlug":"/openapi/file-operations/downloadexportfile","metadata":{"seo":{"title":"Download an exported file","description":"Retrieve a previously generated export file by name. The file_name is returned as part of the export record once the job completes."}},"httpPath":"/leads/api/file-exports/download"}]},{"type":"separator","label":"Outreach"},{"type":"group","label":"Automations","link":"/openapi/automations","routeSlug":"/openapi/automations","items":[{"label":"List automations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/listflows","routeSlug":"/openapi/automations/listflows","metadata":{"seo":{"title":"List automations","description":"Retrieve all outreach automations in your account. Automations are multi-step sequences that send LinkedIn messages, emails, and other actions on a schedule."}},"httpPath":"/flows/api/flows"},{"label":"Create an automation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/createflow","routeSlug":"/openapi/automations/createflow","metadata":{"seo":{"title":"Create an automation","description":"Create a new outreach automation (flow) programmatically. The automation is created in draft status with no node tree yet — add the workflow steps in a second call to POST /flows/api/flows/{flowUuid}/flow-versions, then activate it with PUT /flows/api/flows/{flowUuid}/start."}},"httpPath":"/flows/api/flows"},{"label":"Get an automation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/getflow","routeSlug":"/openapi/automations/getflow","metadata":{"seo":{"title":"Get an automation","description":"Retrieve full details of an automation by UUID."}},"httpPath":"/flows/api/flows/{flowUuid}"},{"label":"Update an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/updateflow","routeSlug":"/openapi/automations/updateflow","metadata":{"seo":{"title":"Update an automation","description":"Update an automation's name, description, or schedule."}},"httpPath":"/flows/api/flows/{flowUuid}"},{"label":"Delete an automation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/deleteflow","routeSlug":"/openapi/automations/deleteflow","metadata":{"seo":{"title":"Delete an automation","description":"Permanently delete an automation. This cannot be undone."}},"httpPath":"/flows/api/flows/{flowUuid}"},{"label":"Start an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/startflow","routeSlug":"/openapi/automations/startflow","metadata":{"seo":{"title":"Start an automation","description":"Activate an automation so it begins processing contacts and executing outreach steps on its schedule."}},"httpPath":"/flows/api/flows/{flowUuid}/start"},{"label":"Stop an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/stopflow","routeSlug":"/openapi/automations/stopflow","metadata":{"seo":{"title":"Stop an automation","description":"Pause an automation. Contacts already in progress will finish their current step."}},"httpPath":"/flows/api/flows/{flowUuid}/stop"},{"label":"Archive an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/archiveflow","routeSlug":"/openapi/automations/archiveflow","metadata":{"seo":{"title":"Archive an automation","description":"Archive an automation. Archived automations cannot be started."}},"httpPath":"/flows/api/flows/{flowUuid}/archive"},{"label":"Unarchive an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/unarchiveflow","routeSlug":"/openapi/automations/unarchiveflow","metadata":{"seo":{"title":"Unarchive an automation","description":"Restore an archived automation so it can be started again."}},"httpPath":"/flows/api/flows/{flowUuid}/unarchive"},{"label":"Clone an automation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/cloneflow","routeSlug":"/openapi/automations/cloneflow","metadata":{"seo":{"title":"Clone an automation","description":"Create a copy of an existing automation with a new name. The cloned automation will be in a stopped state."}},"httpPath":"/flows/api/flows/clone"},{"label":"Automation node statistics (funnel)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/getflownodestatistics","routeSlug":"/openapi/automations/getflownodestatistics","metadata":{"seo":{"title":"Automation node statistics (funnel)","description":"Per-step funnel for an automation — the accurate per-campaign engagement source, matching the web app. For each node you get how many contacts reached each status and the real conversions at that step."}},"httpPath":"/flows/api/flows/{flowUuid}/statistics/nodes"},{"label":"Automation contact-source statistics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/getflowcontactsourcestatistics","routeSlug":"/openapi/automations/getflowcontactsourcestatistics","metadata":{"seo":{"title":"Automation contact-source statistics","description":"Funnel broken down by contact source (audience) of an automation, with a per-channel conversion breakdown. Use it to compare how different audiences of the same flow perform."}},"httpPath":"/flows/api/flows/{flowUuid}/statistics/contact-sources"},{"label":"List flow contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/listflowleads","routeSlug":"/openapi/automations/listflowleads","metadata":{"seo":{"title":"List flow contacts","description":"Search contacts enrolled in automations. Returns flow-lead records that link a contact to a flow with status, current node, and timing fields."}},"httpPath":"/flows/api/flows-leads/list"},{"label":"Remove contact's flow history","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/deleteflowleadhistory","routeSlug":"/openapi/automations/deleteflowleadhistory","metadata":{"seo":{"title":"Remove contact's flow history","description":"Permanently delete all flow-lead records for a contact across all automations. This removes the enrollment history; the contact itself is not deleted."}},"httpPath":"/flows/api/flows/leads/{leadUuid}"},{"label":"List automation folders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/listflowworkspaces","routeSlug":"/openapi/automations/listflowworkspaces","metadata":{"seo":{"title":"List automation folders","description":"List all automation folders (workspaces) for organizing automations."}},"httpPath":"/flows/api/flow-workspaces"},{"label":"Create automation folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/createflowworkspace","routeSlug":"/openapi/automations/createflowworkspace","metadata":{"seo":{"title":"Create automation folder","description":"Create automation folder"}},"httpPath":"/flows/api/flow-workspaces"},{"label":"Update automation folder","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/updateflowworkspace","routeSlug":"/openapi/automations/updateflowworkspace","metadata":{"seo":{"title":"Update automation folder","description":"Update automation folder"}},"httpPath":"/flows/api/flow-workspaces/{uuid}"},{"label":"Delete automation folder","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/deleteflowworkspace","routeSlug":"/openapi/automations/deleteflowworkspace","metadata":{"seo":{"title":"Delete automation folder","description":"Delete automation folder"}},"httpPath":"/flows/api/flow-workspaces/{uuid}"},{"label":"Get automation metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/getflowmetrics","routeSlug":"/openapi/automations/getflowmetrics","metadata":{"seo":{"title":"Get automation metrics","description":"Retrieve current-state metrics for one or more automations: contact counts and the pending task queue per automation UUID."}},"httpPath":"/flows/api/flows/metrics"},{"label":"Add a contact to an automation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/addleadtoflow","routeSlug":"/openapi/automations/addleadtoflow","metadata":{"seo":{"title":"Add a contact to an automation","description":"Add an existing contact to an automation. The contact will enter the automation from the beginning of the sequence."}},"httpPath":"/flows/api/flows/{flowUuid}/leads/{leadUuid}"},{"label":"Create a contact and add to automation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/addnewleadtoflow","routeSlug":"/openapi/automations/addnewleadtoflow","metadata":{"seo":{"title":"Create a contact and add to automation","description":"Create a new contact and immediately add them to an automation. The contact is created in the specified list and starts the automation sequence. If skip_if_lead_exists is true, existing contacts won't be added again."}},"httpPath":"/flows/api/flows/{flowUuid}/add-new-lead"},{"label":"Cancel contact from specific automations","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/cancelleadfromflows","routeSlug":"/openapi/automations/cancelleadfromflows","metadata":{"seo":{"title":"Cancel contact from specific automations","description":"Remove a contact from specific automations. The contact's progress in those automations will be cancelled."}},"httpPath":"/flows/api/flows/leads/{leadUuid}/cancel"},{"label":"Cancel contact from all automations","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/cancelleadfromallflows","routeSlug":"/openapi/automations/cancelleadfromallflows","metadata":{"seo":{"title":"Cancel contact from all automations","description":"Remove a contact from all active automations at once."}},"httpPath":"/flows/api/flows/leads/{leadUuid}/cancel-all"}]},{"type":"group","label":"Flow Versions","link":"/openapi/flow-versions","routeSlug":"/openapi/flow-versions","items":[{"label":"List flow versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/listflowversions","routeSlug":"/openapi/flow-versions/listflowversions","metadata":{"seo":{"title":"List flow versions","description":"List all versions saved for a flow. Each version is an immutable snapshot."}},"httpPath":"/flows/api/flows/{flowUuid}/flow-versions"},{"label":"Create a flow version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/createflowversion","routeSlug":"/openapi/flow-versions/createflowversion","metadata":{"seo":{"title":"Create a flow version","description":"Save a new version (snapshot) of the flow's node tree and contact sources. Versions are immutable; activating a different version replaces the running config."}},"httpPath":"/flows/api/flows/{flowUuid}/flow-versions"},{"label":"Get a flow version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/getflowversion","routeSlug":"/openapi/flow-versions/getflowversion","metadata":{"seo":{"title":"Get a flow version","description":"Retrieve a specific flow version by UUID."}},"httpPath":"/flows/api/flow-versions/{uuid}"},{"label":"Delete a flow version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/deleteflowversion","routeSlug":"/openapi/flow-versions/deleteflowversion","metadata":{"seo":{"title":"Delete a flow version","description":"Permanently delete a flow version. Active versions cannot be deleted."}},"httpPath":"/flows/api/flow-versions/{uuid}"},{"label":"Validate a flow node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/validateflownode","routeSlug":"/openapi/flow-versions/validateflownode","metadata":{"seo":{"title":"Validate a flow node","description":"Validate a single node configuration without saving it. Useful for pre-flight checks when building a flow programmatically. Send the same node object shape you would put inside a flow version (see the flow-node schema)."}},"httpPath":"/flows/api/flow-versions/validate-node"},{"label":"Validate a contact source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/validatecontactsource","routeSlug":"/openapi/flow-versions/validatecontactsource","metadata":{"seo":{"title":"Validate a contact source","description":"Validate a contact source configuration without saving it."}},"httpPath":"/flows/api/flow-versions/validate-contact-source"}]},{"type":"group","label":"Tasks","link":"/openapi/tasks","routeSlug":"/openapi/tasks","items":[{"label":"List tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/listtasks","routeSlug":"/openapi/tasks/listtasks","metadata":{"seo":{"title":"List tasks","description":"Retrieve outreach tasks. Tasks are the individual actions an automation executes (or that you create manually) — one task per contact per step."}},"httpPath":"/flows/api/tasks"},{"label":"Create a task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/createtask","routeSlug":"/openapi/tasks/createtask","metadata":{"seo":{"title":"Create a task","description":"Create a manual outreach task. Common types: linkedin_send_message, linkedin_send_connection_request, linkedin_send_inmail, linkedin_like_latest_post, linkedin_endorse_skills."}},"httpPath":"/flows/api/tasks"},{"label":"Get a task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/gettask","routeSlug":"/openapi/tasks/gettask","metadata":{"seo":{"title":"Get a task","description":"Retrieve details of a specific task."}},"httpPath":"/flows/api/tasks/{uuid}"},{"label":"Complete a task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/completetask","routeSlug":"/openapi/tasks/completetask","metadata":{"seo":{"title":"Complete a task","description":"Mark a manual task as completed. Only works for manual tasks."}},"httpPath":"/flows/api/tasks/{uuid}/complete"},{"label":"Cancel a task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/canceltask","routeSlug":"/openapi/tasks/canceltask","metadata":{"seo":{"title":"Cancel a task","description":"Cancel a manual task. Only works for manual tasks."}},"httpPath":"/flows/api/tasks/{uuid}/cancel"},{"label":"Mark a task as failed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/failtask","routeSlug":"/openapi/tasks/failtask","metadata":{"seo":{"title":"Mark a task as failed","description":"Mark a manual task as failed. Only works for manual tasks."}},"httpPath":"/flows/api/tasks/{uuid}/fail"},{"label":"Continue automation for a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/continueautomation","routeSlug":"/openapi/tasks/continueautomation","metadata":{"seo":{"title":"Continue automation for a contact","description":"Resume a paused automation for a specific contact. The contact will continue from where they were paused in the automation sequence."}},"httpPath":"/flows/api/tasks/continue-automation"},{"label":"Get tasks schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/gettasksschedule","routeSlug":"/openapi/tasks/gettasksschedule","metadata":{"seo":{"title":"Get tasks schedule","description":"Get the tasks schedule for a specific sender profile on a given date. Returns the timeline of scheduled tasks."}},"httpPath":"/flows/api/tasks/schedule"},{"label":"Mass cancel tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/masscanceltasks","routeSlug":"/openapi/tasks/masscanceltasks","metadata":{"seo":{"title":"Mass cancel tasks","description":"Cancel multiple manual tasks at once. Only works for manual tasks."}},"httpPath":"/flows/api/tasks/mass-cancel"},{"label":"Mass complete tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/masscompletetasks","routeSlug":"/openapi/tasks/masscompletetasks","metadata":{"seo":{"title":"Mass complete tasks","description":"Mark multiple manual tasks as completed at once."}},"httpPath":"/flows/api/tasks/mass-complete"},{"label":"Mass retry tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/massretrytasks","routeSlug":"/openapi/tasks/massretrytasks","metadata":{"seo":{"title":"Mass retry tasks","description":"Retry multiple failed manual tasks at once."}},"httpPath":"/flows/api/tasks/mass-retry"},{"label":"Mass skip tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/massskiptasks","routeSlug":"/openapi/tasks/massskiptasks","metadata":{"seo":{"title":"Mass skip tasks","description":"Skip multiple manual tasks at once."}},"httpPath":"/flows/api/tasks/mass-skip"},{"label":"Group counts for tasks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/groupcounttasks","routeSlug":"/openapi/tasks/groupcounttasks","metadata":{"seo":{"title":"Group counts for tasks","description":"Return task counts broken down by a field, in a single request — the efficient way to get per-campaign, per-sender or per-type activity without one call per slice."}},"httpPath":"/flows/api/tasks/group-counts"}]},{"type":"group","label":"Sender Profiles","link":"/openapi/sender-profiles","routeSlug":"/openapi/sender-profiles","items":[{"label":"List sender profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/listsenderprofiles","routeSlug":"/openapi/sender-profiles/listsenderprofiles","metadata":{"seo":{"title":"List sender profiles","description":"Retrieve all sender profiles. A sender profile represents a person (with linked LinkedIn account and/or email mailbox) who sends outreach messages."}},"httpPath":"/flows/api/sender-profiles"},{"label":"Create a sender profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/createsenderprofile","routeSlug":"/openapi/sender-profiles/createsenderprofile","metadata":{"seo":{"title":"Create a sender profile","description":"Create a sender profile — the channel identity that sends messages. This is step 1 of connecting a LinkedIn account for an end user; attach a LinkedIn seat next with POST /browsers/api/linkedin-browsers, then mint a Smart Login link."}},"httpPath":"/flows/api/sender-profiles"},{"label":"Get a sender profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/getsenderprofile","routeSlug":"/openapi/sender-profiles/getsenderprofile","metadata":{"seo":{"title":"Get a sender profile","description":"Retrieve details of a sender profile."}},"httpPath":"/flows/api/sender-profiles/{uuid}"},{"label":"Update a sender profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/updatesenderprofile","routeSlug":"/openapi/sender-profiles/updatesenderprofile","metadata":{"seo":{"title":"Update a sender profile","description":"Update a sender profile's name, label, or schedule."}},"httpPath":"/flows/api/sender-profiles/{uuid}"},{"label":"Delete a sender profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/deletesenderprofile","routeSlug":"/openapi/sender-profiles/deletesenderprofile","metadata":{"seo":{"title":"Delete a sender profile","description":"Permanently delete a sender profile."}},"httpPath":"/flows/api/sender-profiles/{uuid}"},{"label":"Enable a sender profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/enablesenderprofile","routeSlug":"/openapi/sender-profiles/enablesenderprofile","metadata":{"seo":{"title":"Enable a sender profile","description":"Enable a sender profile so it can be used in automations."}},"httpPath":"/flows/api/sender-profiles/{uuid}/enable"},{"label":"Disable a sender profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/disablesenderprofile","routeSlug":"/openapi/sender-profiles/disablesenderprofile","metadata":{"seo":{"title":"Disable a sender profile","description":"Disable a sender profile. It will no longer be used in automations."}},"httpPath":"/flows/api/sender-profiles/{uuid}/disable"}]},{"type":"separator","label":"AI"},{"type":"group","label":"AI Agents","link":"/openapi/ai-agents","routeSlug":"/openapi/ai-agents","items":[{"label":"List AI Agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/listaiagents","routeSlug":"/openapi/ai-agents/listaiagents","metadata":{"seo":{"title":"List AI Agents","description":"Returns all AI agents in the team with their LLM configuration and metadata."}},"httpPath":"/flows/api/ai-agents"},{"label":"Create an AI Agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/createaiagent","routeSlug":"/openapi/ai-agents/createaiagent","metadata":{"seo":{"title":"Create an AI Agent","description":"Create a new AI agent that will use the configured LLM for classification and similar tasks. Requires a connected LLM (classification_llm_uuid)."}},"httpPath":"/flows/api/ai-agents"},{"label":"Get an AI Agent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/getaiagent","routeSlug":"/openapi/ai-agents/getaiagent","metadata":{"seo":{"title":"Get an AI Agent","description":"Retrieve a single AI agent by UUID."}},"httpPath":"/flows/api/ai-agents/{uuid}"},{"label":"Update an AI Agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/updateaiagent","routeSlug":"/openapi/ai-agents/updateaiagent","metadata":{"seo":{"title":"Update an AI Agent","description":"Update fields on an existing AI agent. Only the supplied fields are changed."}},"httpPath":"/flows/api/ai-agents/{uuid}"},{"label":"Delete an AI Agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/deleteaiagent","routeSlug":"/openapi/ai-agents/deleteaiagent","metadata":{"seo":{"title":"Delete an AI Agent","description":"Permanently delete an AI agent. Cannot be undone."}},"httpPath":"/flows/api/ai-agents/{uuid}"}]},{"type":"group","label":"AI Templates","link":"/openapi/ai-templates","routeSlug":"/openapi/ai-templates","items":[{"label":"List AI Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/listaitemplates","routeSlug":"/openapi/ai-templates/listaitemplates","metadata":{"seo":{"title":"List AI Templates","description":"List all AI templates (reusable AI-driven message snippets) for the team."}},"httpPath":"/flows/api/ai-templates"},{"label":"Create an AI Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/createaitemplate","routeSlug":"/openapi/ai-templates/createaitemplate","metadata":{"seo":{"title":"Create an AI Template","description":"Create a reusable message template. Templates are referenced from flow nodes by their uuid (the template_uuid field on linkedin_send_message, email_send_message, etc.)."}},"httpPath":"/flows/api/ai-templates"},{"label":"Get an AI Template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/getaitemplate","routeSlug":"/openapi/ai-templates/getaitemplate","metadata":{"seo":{"title":"Get an AI Template","description":"Retrieve a single AI template by UUID, including its prompt and LLM config."}},"httpPath":"/flows/api/ai-templates/{uuid}"},{"label":"Update an AI Template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/updateaitemplate","routeSlug":"/openapi/ai-templates/updateaitemplate","metadata":{"seo":{"title":"Update an AI Template","description":"Update fields on an existing AI template."}},"httpPath":"/flows/api/ai-templates/{uuid}"},{"label":"Delete an AI Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/deleteaitemplate","routeSlug":"/openapi/ai-templates/deleteaitemplate","metadata":{"seo":{"title":"Delete an AI Template","description":"Delete an AI template. Returns 204; the deletion takes effect (the template disappears from the web app)."}},"httpPath":"/flows/api/ai-templates/{uuid}"},{"label":"Render an AI Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/renderaitemplate","routeSlug":"/openapi/ai-templates/renderaitemplate","metadata":{"seo":{"title":"Render an AI Template","description":"Render a template for a specific contact and sender profile. The simplest usage is to pass an existing template uuid along with lead_uuid and sender_profile_uuid — the saved template configuration is used."}},"httpPath":"/flows/api/ai-templates/render"}]},{"type":"separator","label":"Messaging"},{"type":"group","label":"LinkedIn Messages","link":"/openapi/linkedin-messages","routeSlug":"/openapi/linkedin-messages","items":[{"label":"List LinkedIn messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/listlinkedinmessages","routeSlug":"/openapi/linkedin-messages/listlinkedinmessages","metadata":{"seo":{"title":"List LinkedIn messages","description":"Retrieve LinkedIn messages from your unified inbox. Filter by contact, sender profile, conversation, message type (inbox/outbox), and status."}},"httpPath":"/flows/api/linkedin-messages"},{"label":"Send a LinkedIn message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/sendlinkedinmessage","routeSlug":"/openapi/linkedin-messages/sendlinkedinmessage","metadata":{"seo":{"title":"Send a LinkedIn message","description":"Send a LinkedIn message to a contact through a sender profile. The message will be queued and sent via the linked LinkedIn account."}},"httpPath":"/flows/api/linkedin-messages"},{"label":"Delete a LinkedIn message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/deletelinkedinmessage","routeSlug":"/openapi/linkedin-messages/deletelinkedinmessage","metadata":{"seo":{"title":"Delete a LinkedIn message","description":"Delete a LinkedIn message record."}},"httpPath":"/flows/api/linkedin-messages/{uuid}"},{"label":"Retry a failed LinkedIn message","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/retrylinkedinmessage","routeSlug":"/openapi/linkedin-messages/retrylinkedinmessage","metadata":{"seo":{"title":"Retry a failed LinkedIn message","description":"Retry sending a LinkedIn message that previously failed."}},"httpPath":"/flows/api/linkedin-messages/{uuid}/retry"},{"label":"Group counts for LinkedIn messages","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/groupcountlinkedinmessages","routeSlug":"/openapi/linkedin-messages/groupcountlinkedinmessages","metadata":{"seo":{"title":"Group counts for LinkedIn messages","description":"Return LinkedIn-message counts broken down by a field, in one request. This is the right way to get per-sender messaging activity — including replies per sender (group_field: sender_profile_uuid + filter.type: inbox)."}},"httpPath":"/flows/api/linkedin-messages/group-counts"}]},{"type":"group","label":"Emails","link":"/openapi/emails","routeSlug":"/openapi/emails","items":[{"label":"List emails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/listemails","routeSlug":"/openapi/emails/listemails","metadata":{"seo":{"title":"List emails","description":"Retrieve emails from your unified inbox. Filter by contact, mailbox, automation (flow_uuid), type (inbox/outbox), status, and date range."}},"httpPath":"/emails/api/emails"},{"label":"Get an email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getemail","routeSlug":"/openapi/emails/getemail","metadata":{"seo":{"title":"Get an email","description":"Retrieve full details of an email by UUID."}},"httpPath":"/emails/api/emails/{uuid}"},{"label":"Delete an email","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/deleteemail","routeSlug":"/openapi/emails/deleteemail","metadata":{"seo":{"title":"Delete an email","description":"Delete an email record."}},"httpPath":"/emails/api/emails/{uuid}"},{"label":"Send an email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/sendemail","routeSlug":"/openapi/emails/sendemail","metadata":{"seo":{"title":"Send an email","description":"Send a new email to a contact through a connected mailbox."}},"httpPath":"/emails/api/emails/send-email"},{"label":"List email bodies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/listemailbodies","routeSlug":"/openapi/emails/listemailbodies","metadata":{"seo":{"title":"List email bodies","description":"List email body records (HTML content, subject, attachments)."}},"httpPath":"/emails/api/email-bodies"},{"label":"Get an email body","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getemailbody","routeSlug":"/openapi/emails/getemailbody","metadata":{"seo":{"title":"Get an email body","description":"Get the HTML content, subject, and attachments of an email body."}},"httpPath":"/emails/api/email-bodies/{uuid}"},{"label":"Get email thread","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getemailthread","routeSlug":"/openapi/emails/getemailthread","metadata":{"seo":{"title":"Get email thread","description":"Get the conversation thread for a reply email."}},"httpPath":"/emails/api/emails/{uuid}/thread"},{"label":"Get latest emails by leads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getlatestemailsbyleads","routeSlug":"/openapi/emails/getlatestemailsbyleads","metadata":{"seo":{"title":"Get latest emails by leads","description":"Get the most recent email for each of the specified contact UUIDs."}},"httpPath":"/emails/api/emails/latest-by-leads"},{"label":"Get email thread for LLM","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getemailllmthread","routeSlug":"/openapi/emails/getemailllmthread","metadata":{"seo":{"title":"Get email thread for LLM","description":"Get an email conversation thread formatted for LLM processing. Optimized for AI analysis and response generation."}},"httpPath":"/emails/api/emails/llm-thread"}]},{"type":"group","label":"Mailboxes","link":"/openapi/mailboxes","routeSlug":"/openapi/mailboxes","items":[{"label":"List mailboxes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/listmailboxes","routeSlug":"/openapi/mailboxes/listmailboxes","metadata":{"seo":{"title":"List mailboxes","description":"Retrieve all email mailboxes (SMTP/IMAP, Gmail, Outlook) configured in your account."}},"httpPath":"/emails/api/mailboxes"},{"label":"Create a mailbox","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/createmailbox","routeSlug":"/openapi/mailboxes/createmailbox","metadata":{"seo":{"title":"Create a mailbox","description":"Add a new SMTP/IMAP mailbox with connection settings."}},"httpPath":"/emails/api/mailboxes"},{"label":"Get a mailbox","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/getmailbox","routeSlug":"/openapi/mailboxes/getmailbox","metadata":{"seo":{"title":"Get a mailbox","description":"Retrieve details of a specific mailbox."}},"httpPath":"/emails/api/mailboxes/{uuid}"},{"label":"Update a mailbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/updatemailbox","routeSlug":"/openapi/mailboxes/updatemailbox","metadata":{"seo":{"title":"Update a mailbox","description":"Update mailbox settings such as sender name, daily limits, or connection details."}},"httpPath":"/emails/api/mailboxes/{uuid}"},{"label":"Delete a mailbox","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/deletemailbox","routeSlug":"/openapi/mailboxes/deletemailbox","metadata":{"seo":{"title":"Delete a mailbox","description":"Delete a mailbox. Optionally reassign automations to another mailbox."}},"httpPath":"/emails/api/mailboxes/{uuid}"},{"label":"Activate a mailbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/activatemailbox","routeSlug":"/openapi/mailboxes/activatemailbox","metadata":{"seo":{"title":"Activate a mailbox","description":"Enable a mailbox so it can send and sync emails."}},"httpPath":"/emails/api/mailboxes/{uuid}/activate"},{"label":"Deactivate a mailbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/deactivatemailbox","routeSlug":"/openapi/mailboxes/deactivatemailbox","metadata":{"seo":{"title":"Deactivate a mailbox","description":"Disable a mailbox. It will stop sending and syncing emails."}},"httpPath":"/emails/api/mailboxes/{uuid}/deactivate"},{"label":"List mailbox errors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/listmailboxerrors","routeSlug":"/openapi/mailboxes/listmailboxerrors","metadata":{"seo":{"title":"List mailbox errors","description":"List mailbox send/sync errors for debugging. Shows errors with timestamps and details."}},"httpPath":"/emails/api/mailbox-errors"}]},{"type":"group","label":"Attachments","link":"/openapi/attachments","routeSlug":"/openapi/attachments","items":[{"label":"List attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/listattachments","routeSlug":"/openapi/attachments/listattachments","metadata":{"seo":{"title":"List attachments","description":"List files uploaded to your team's attachment storage. Attachments can be referenced by UUID when sending LinkedIn messages, emails, or from automation message nodes."}},"httpPath":"/flows/api/attachments"},{"label":"Upload an attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/uploadattachment","routeSlug":"/openapi/attachments/uploadattachment","metadata":{"seo":{"title":"Upload an attachment","description":"Upload a file (image, PDF, document) to attachment storage. Use multipart/form-data. Returns an attachment UUID that can be used in attachments: [{ \"uuid\": \"...\" }] when sending LinkedIn messages or emails. Supported types include images (JPG, PNG, GIF), documents (PDF, DOCX), and other common formats."}},"httpPath":"/flows/api/attachments"},{"label":"Get an attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/getattachment","routeSlug":"/openapi/attachments/getattachment","metadata":{"seo":{"title":"Get an attachment","description":"Get an attachment"}},"httpPath":"/flows/api/attachments/{uuid}"},{"label":"Delete an attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/deleteattachment","routeSlug":"/openapi/attachments/deleteattachment","metadata":{"seo":{"title":"Delete an attachment","description":"Delete an attachment"}},"httpPath":"/flows/api/attachments/{uuid}"}]},{"type":"separator","label":"Browsers"},{"type":"group","label":"LinkedIn Browsers","link":"/openapi/linkedin-browsers","routeSlug":"/openapi/linkedin-browsers","items":[{"label":"List LinkedIn browsers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/listlinkedinbrowsers","routeSlug":"/openapi/linkedin-browsers/listlinkedinbrowsers","metadata":{"seo":{"title":"List LinkedIn browsers","description":"List all LinkedIn browser profiles with pagination."}},"httpPath":"/browsers/api/linkedin-browsers/list"},{"label":"Get a LinkedIn browser","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/getlinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/getlinkedinbrowser","metadata":{"seo":{"title":"Get a LinkedIn browser","description":"Get a LinkedIn browser"}},"httpPath":"/browsers/api/linkedin-browsers/{id}"},{"label":"Update a LinkedIn browser","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/updatelinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/updatelinkedinbrowser","metadata":{"seo":{"title":"Update a LinkedIn browser","description":"Update a LinkedIn browser"}},"httpPath":"/browsers/api/linkedin-browsers/{id}"},{"label":"Delete a LinkedIn browser","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/deletelinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/deletelinkedinbrowser","metadata":{"seo":{"title":"Delete a LinkedIn browser","description":"Delete a LinkedIn browser"}},"httpPath":"/browsers/api/linkedin-browsers/{id}"},{"label":"Create a LinkedIn browser (seat)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/createlinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/createlinkedinbrowser","metadata":{"seo":{"title":"Create a LinkedIn browser (seat)","description":"Create a LinkedIn browser \"seat\" bound to a sender profile. This is step 2 of connecting a LinkedIn account without the user ever logging into Grinfi:"}},"httpPath":"/browsers/api/linkedin-browsers"},{"label":"Generate a Smart Login link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/generatebrowseraccesskey","routeSlug":"/openapi/linkedin-browsers/generatebrowseraccesskey","metadata":{"seo":{"title":"Generate a Smart Login link","description":"Mint a public, no-auth Smart Login link for a seat — the way an end user connects their LinkedIn account without a Grinfi login. Returns external_access_key and a cloud_browser_url; opening the URL provisions a hosted cloud browser where the user logs into LinkedIn. The link is valid 7 days and can be embedded in an iframe or forwarded to the account owner."}},"httpPath":"/browsers/api/linkedin-browsers/{id}/generate-external-access-key"},{"label":"Start a browser session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/runlinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/runlinkedinbrowser","metadata":{"seo":{"title":"Start a browser session","description":"Resume a previously logged-in LinkedIn browser session that was intentionally stopped. Do not call this during onboarding — starting a never-logged-in seat forces login_issue. The backend starts a seat automatically when Smart Login completes. Use this only to recover a seat the user manually stopped."}},"httpPath":"/browsers/api/linkedin-browsers/{id}/run"},{"label":"Stop a browser session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/stoplinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/stoplinkedinbrowser","metadata":{"seo":{"title":"Stop a browser session","description":"Stop a browser session"}},"httpPath":"/browsers/api/linkedin-browsers/{id}/stop"},{"label":"Set browser proxy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/setlinkedinbrowserproxy","routeSlug":"/openapi/linkedin-browsers/setlinkedinbrowserproxy","metadata":{"seo":{"title":"Set browser proxy","description":"Change the proxy configuration for a LinkedIn browser."}},"httpPath":"/browsers/api/linkedin-browsers/{id}/set-proxy"},{"label":"Share browser profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/sharelinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/sharelinkedinbrowser","metadata":{"seo":{"title":"Share browser profile","description":"Share a LinkedIn browser profile with another team member."}},"httpPath":"/browsers/api/linkedin-browsers/{id}/share"}]},{"type":"separator","label":"Integrations"},{"type":"group","label":"Webhooks","link":"/openapi/webhooks","routeSlug":"/openapi/webhooks","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/listwebhooks","routeSlug":"/openapi/webhooks/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"List all webhooks configured in your account. Webhooks send HTTP requests to your target URL when specified events occur."}},"httpPath":"/integrations/api/webhooks"},{"label":"Create a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/createwebhook","routeSlug":"/openapi/webhooks/createwebhook","metadata":{"seo":{"title":"Create a webhook","description":"Create a new webhook that fires on the specified event. Optionally add filters to narrow which contacts trigger the webhook."}},"httpPath":"/integrations/api/webhooks"},{"label":"Get a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/getwebhook","routeSlug":"/openapi/webhooks/getwebhook","metadata":{"seo":{"title":"Get a webhook","description":"Retrieve full details of a webhook by UUID."}},"httpPath":"/integrations/api/webhooks/{uuid}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/updatewebhook","routeSlug":"/openapi/webhooks/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Update one or more fields on an existing webhook. Only include the fields you want to change."}},"httpPath":"/integrations/api/webhooks/{uuid}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/deletewebhook","routeSlug":"/openapi/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Permanently remove a webhook."}},"httpPath":"/integrations/api/webhooks/{uuid}"},{"label":"Test a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/testwebhook","routeSlug":"/openapi/webhooks/testwebhook","metadata":{"seo":{"title":"Test a webhook","description":"Send a sample payload for the given event to a target URL and return the target's response — use it to verify connectivity and see the payload shape for an event."}},"httpPath":"/integrations/api/webhooks/test"}]}]}