{ "generated_at": "2026-11-06T17:48:49+00:00", "base_url": "https://api.coherta.com", "stats": { "total": 100, "bearer": 86, "open": 14, "groups": 22 }, "endpoints": [ { "path": "/auth/google", "title": "Auth / Google", "summary": "Handle the Google OAuth callback flow.", "group": "Auth", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "affiliate", "bo_affiliate", "code", "error", "error_description", "return_url", "source", "state", "stripe_enabled", "transactionid" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/token", "title": "Token", "summary": "Exchange a username and password for a JWT access token.", "group": "Authentication", "methods": [ "POST" ], "auth": "open", "queryParams": [], "formParams": [ "password", "username" ], "jsonParams": [ "password", "username" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/token/renew", "title": "Token / Renew", "summary": "Refresh an existing bearer token and receive a new JWT.", "group": "Authentication", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/campaigns", "title": "Campaigns", "summary": "List or manage campaigns.", "group": "Campaigns", "methods": [ "DELETE", "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/campaigns/attached_contacts", "title": "Campaigns / Attached Contacts", "summary": "Public API endpoint.", "group": "Campaigns", "methods": [ "GET", "PATCH" ], "auth": "bearer", "queryParams": [ "campaign_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/campaigns/connected_contacts", "title": "Campaigns / Connected Contacts", "summary": "Public API endpoint.", "group": "Campaigns", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "campaign_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/campaigns/employee_settings", "title": "Campaigns / Employee Settings", "summary": "Public API endpoint.", "group": "Campaigns", "methods": [ "DELETE", "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "employee_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/campaigns/lead_exists", "title": "Campaigns / Lead Exists", "summary": "Check whether a LinkedIn profile belongs to an active campaign in an accessible company.", "group": "Campaigns", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "linkedin_url" ], "formParams": [], "jsonParams": [ "linkedin_url" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Requires linkedin_url (linkedin is an alias). Returns a JSON boolean. A missing or invalid profile URL returns 400." ], "example": null }, { "path": "/campaigns/linked_posts", "title": "Campaigns / Linked Posts", "summary": "List or save LinkedIn posts associated with a campaign.", "group": "Campaigns", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "campaign_id" ], "formParams": [], "jsonParams": [ "campaign_id", "urn", "external_post_id", "post_url", "author_urn", "author_name", "post_text", "published_at" ], "routePatterns": [], "supportsPathId": false, "notes": [ "GET requires campaign_id and returns the linked posts. POST requires campaign_id and urn, with optional post details. Returns HTTP 201 with id, post_id, campaign_id, company_id and urn." ], "example": null }, { "path": "/campaigns/lists", "title": "Campaigns / Lists", "summary": "Save a prospecting search, qualify selected people, or start and poll LinkedIn discovery.", "group": "Campaigns", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "discovery_campaign_id", "page" ], "formParams": [], "jsonParams": [ "action", "title", "filters", "view", "request_id", "campaign_id", "participant_ids", "discovery_campaign_id", "screening_context", "outreach", "first_message", "employee_title", "country" ], "routePatterns": [], "supportsPathId": false, "notes": [ "GET returns lists (up to 200 saved searches), each with id, title, filters and view. With discovery_campaign_id, GET instead returns id, items, total, collected, page, page_size, status, started_at, employee_title and country. Discovery pages contain up to 50 people in discovery order; total counts resolved people and collected counts collected leads.", "Every POST requires title (1\u2013150 characters), filters using the /prospecting shape, and request_id (16\u201380 letters, digits, underscores or hyphens). view is people (default) or companies. Reuse the same request_id when retrying the same operation; use a new value for a new operation or edit.", "action=save (default) saves a search. Optional campaign_id updates an existing saved search you can access.", "action=qualify requires 1\u2013500 participant_ids and screening_context (nonblank, up to 10000 bytes). People must still match the supplied filters, or belong to discovery_campaign_id when supplied. outreach is a boolean, default false; enabling it requires a nonblank first_message (up to 8000 bytes). This creates a campaign and people list for qualification, with optional LinkedIn outreach.", "action=discover requires a connected LinkedIn account, employee_title (1\u2013200 characters), country (1\u2013100 characters) and screening_context (1\u201310000 characters). It starts discovery and creates a people list for qualified leads. Poll GET with the returned id as discovery_campaign_id; items have the same person fields as /prospecting.", "POST returns HTTP 201 with id, attached_count and pipeline_id (null for a saved search). Retried operations also return replayed=true. Invalid input returns 422; discovery not found returns 404; a retryable save failure returns 503." ], "example": { "action": "save", "title": "Danish founders", "filters": { "job_title": "Founder", "company_country": "Denmark" }, "view": "people", "request_id": "example-save-request-0001" } }, { "path": "/campaigns/lists/contact", "title": "Campaigns / Lists / Contact", "summary": "Find an email address or phone number for a prospecting participant.", "group": "Campaigns", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "participant_id", "field" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Requires a positive participant_id and field=email or field=phone. Returns participant_id, field, value (null if not found) and cached. Existing contact values return cached=true.", "A new lookup needs an available Lead Monitoring (LM) slot unless the person is already actively monitored. The temporary slot is released after the lookup; existing monitoring is preserved.", "Errors: 402 with code=lm_credits_exhausted and credits when no slot is available; 404 for a missing lead; 409 for a lookup already in progress; 422 for invalid fields or an unusable profile; 429 for a repeated lookup within five minutes; 502/503 for service failure; 504 for timeout." ], "example": { "participant_id": 123, "field": "email" } }, { "path": "/campaigns/lists/people", "title": "Campaigns / Lists / People", "summary": "Add selected people directly to a lead list or existing campaign.", "group": "Campaigns", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "request_id" ], "formParams": [], "jsonParams": [ "action", "request_id", "participant_ids", "pipeline_id", "campaign_id", "title", "enrich_phone", "enrich_email" ], "routePatterns": [], "supportsPathId": false, "notes": [ "GET returns lead_lists (id/title) and campaigns (id/title/status; 0 active, 1 paused) for the authenticated company. Campaigns require a connected workflow. GET with request_id returns the creator-scoped result, enrichment field counts (queued, processing, completed, not_found, failed), and finished.", "POST requires action=add_to_list or add_to_campaign, one or more positive participant_ids, and request_id (16\u201380 letters/digits/underscores/hyphens). Reuse the identifier for retries of identical input. The server uses only these people and never starts a discovery search.", "add_to_list accepts a people pipeline_id, or pipeline_id=0 plus a new title (1\u2013150 characters). Optional enrich_phone/enrich_email are booleans defaulting to false. Missing contact fields are queued independently and continue in the background; a list is usable immediately. Lookups need available Lead Monitoring capacity. No campaign is created.", "add_to_campaign requires campaign_id. It preserves campaign settings/status and starts new people at the existing workflow entry. Active workflows may send invitations/messages; paused campaigns remain paused. Existing members are skipped.", "POST returns destination_id, title, action, created, selected_count, added_count, skipped_count, enrichment_queued and request_id. Campaign results include campaign_status; retries include replayed=true. Errors: 422 invalid input/reused key with changed input, 404 unavailable destination or receipt, 503 retryable server failure." ], "example": { "action": "add_to_list", "pipeline_id": 0, "title": "Selected people", "participant_ids": [ 123, 456 ], "enrich_phone": true, "enrich_email": false, "request_id": "example-selection-0001" } }, { "path": "/campaigns/messages", "title": "Campaigns / Messages", "summary": "Return campaign messages and related threads.", "group": "Campaigns", "methods": [ "DELETE", "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "campaign_id", "employee_id", "message_id", "mode", "thread_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/campaigns/messages/access", "title": "Campaigns / Messages / Access", "summary": "Public API endpoint.", "group": "Campaigns", "methods": [ "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "accept_id", "accept_token", "access_graned_to", "access_granted_to", "action", "granted_to_user_id", "id", "owner_user_id", "request_token", "token", "user_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/campaigns/messages/search", "title": "Campaigns / Messages / Search", "summary": "Search an accessible employee inbox for people and messages.", "group": "Campaigns", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "employee_id", "scope", "query", "limit" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [ "Requires positive employee_id, scope=everything, person or message, and query (2\u2013200 characters). limit defaults to 50 and is capped at 50. Returns results. Validation errors return 422; an inaccessible inbox returns 403." ], "example": null }, { "path": "/campaigns/settings", "title": "Campaigns / Settings", "summary": "Public API endpoint.", "group": "Campaigns", "methods": [ "DELETE", "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "campaign_id", "scope" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/campaigns/statistics", "title": "Campaigns / Statistics", "summary": "Return campaign statistics for a date range or employee.", "group": "Campaigns", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "campaign_id", "date_from", "date_to", "employee_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/campaigns/workflow/attached", "title": "Campaigns / Workflow / Attached", "summary": "List campaign contacts currently in a workflow, including screening results.", "group": "Campaigns", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "campaign_id", "scope" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": true, "notes": [ "campaign_id is required. By default, returns active leads with pending workflow actions. Use scope=all to include all attached opportunities for that campaign, including completed and stopped leads. Returns count and contacts ordered by latest automated_screening_score descending, with unscored leads last and lead ID descending for ties. No limit parameter is supported." ], "example": null }, { "path": "/campaigns/workflow/continue", "title": "Campaigns / Workflow / Continue", "summary": "Move a campaign lead from its current workflow node to the next node.", "group": "Campaigns", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "campaign_id", "lead_id", "current_node_id", "next_node_id", "user_id", "linkedin_url" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Requires campaign_id, lead_id and current_node_id. lead_id identifies the campaign lead. id and node_id are accepted aliases for campaign_id and current_node_id; supplying both requires matching values.", "Use the latest current_node_id from the attached workflow contacts. A stale node or mismatched optional user_id/linkedin_url returns 409; inaccessible or missing leads return 404. For a branching node, supply next_node_id." ], "example": { "campaign_id": 123, "lead_id": 456, "current_node_id": "screening" } }, { "path": "/campaigns/workflow/stop", "title": "Campaigns / Workflow / Stop", "summary": "Stop the workflow for a campaign lead.", "group": "Campaigns", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "campaign_id", "lead_id", "current_node_id", "next_node_id", "user_id", "linkedin_url" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Requires campaign_id, lead_id and current_node_id. lead_id identifies the campaign lead. id and node_id are accepted aliases for campaign_id and current_node_id; supplying both requires matching values.", "Use the latest current_node_id from the attached workflow contacts. A stale node or mismatched optional user_id/linkedin_url returns 409; inaccessible or missing leads return 404. For a branching node, supply next_node_id." ], "example": { "campaign_id": 123, "lead_id": 456, "current_node_id": "screening" } }, { "path": "/company/employees/monthly", "title": "Company / Employees / Monthly", "summary": "Public API endpoint.", "group": "Company", "methods": [ "GET" ], "auth": "open", "queryParams": [ "company_uid" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/company/users", "title": "Company / Users", "summary": "List users associated with a company.", "group": "Company", "methods": [ "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [ "/company/users", "/company/users/{param1}" ], "supportsPathId": false, "notes": [], "example": null }, { "path": "/dashboard/linkedin", "title": "Dashboard / Linkedin", "summary": "Read LinkedIn activity and audience metrics for a personal profile or company page.", "group": "Dashboard", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "scope", "days", "page_id", "company_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [ "scope defaults to personal; use company for a company page. days defaults to 28 and is clamped to 7\u2013365. For company scope, page_id (or company_id) selects an accessible LinkedIn page." ], "example": null }, { "path": "/dashboard/overview", "title": "Dashboard / Overview", "summary": "Provide dashboard overview data.", "group": "Dashboard", "methods": [ "GET" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/filter/company", "title": "Filter / Company", "summary": "Filter companies using the classic company filter set.", "group": "Filters", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/filter/company/categories", "title": "Filter / Company / Categories", "summary": "Public API endpoint.", "group": "Filters", "methods": [ "GET" ], "auth": "open", "queryParams": [ "t" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/filter/company/guests", "title": "Filter / Company / Guests", "summary": "Public API endpoint.", "group": "Filters", "methods": [ "POST" ], "auth": "open", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/filter/company/phonenumbers", "title": "Filter / Company / Phonenumbers", "summary": "Public API endpoint.", "group": "Filters", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/filter/company_new", "title": "Filter / Company New", "summary": "Filter companies using the newer filtering engine.", "group": "Filters", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/filter/company_new2", "title": "Filter / Company New2", "summary": "Alternative company filtering endpoint using the newer model.", "group": "Filters", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/filter/field/mapping", "title": "Filter / Field / Mapping", "summary": "Public API endpoint.", "group": "Filters", "methods": [ "GET" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/filter/people", "title": "Filter / People", "summary": "Find people based on filter criteria.", "group": "Filters", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/gtm/templates", "title": "Gtm / Templates", "summary": "Public API endpoint.", "group": "GTM", "methods": [ "GET" ], "auth": "open", "queryParams": [ "featured", "id", "search" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/gtm/templates/sample", "title": "Gtm / Templates / Sample", "summary": "Public API endpoint.", "group": "GTM", "methods": [ "GET" ], "auth": "open", "queryParams": [ "list_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/gtm/templates/sample/company_data", "title": "Gtm / Templates / Sample / Company Data", "summary": "Public API endpoint.", "group": "GTM", "methods": [ "GET" ], "auth": "open", "queryParams": [ "country_code", "domain_id", "list_id", "vat_code" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/introductions/signup", "title": "Introductions / Signup", "summary": "Create an account for Get an Introduction.", "group": "Introductions", "methods": [ "POST" ], "auth": "open", "queryParams": [], "formParams": [], "jsonParams": [ "name", "email", "password" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Requires name (up to 120 characters), a valid email (up to 254 bytes) and password (12\u201372 bytes). Send JSON, up to 16 KiB. Validation errors return 422 and rate limits return 429." ], "example": null }, { "path": "/stakeholder/monitoring", "title": "Stakeholder / Monitoring", "summary": "List, add, update or remove stakeholder monitoring for an accessible company.", "group": "Lead Monitoring", "methods": [ "GET", "POST", "PATCH", "DELETE" ], "auth": "bearer", "queryParams": [ "company_id", "scope", "status" ], "formParams": [], "jsonParams": [ "company_id", "participant_linkedin_id", "linkedin_url", "participant_linkedin", "name", "email", "phonenumber", "phonenumber_2", "status", "note", "source", "user_id" ], "routePatterns": [ "/stakeholder/monitoring/{param1}" ], "supportsPathId": false, "notes": [ "POST accepts participant_linkedin_id or participant details. linkedin_url (alias participant_linkedin) accepts person profile URLs with or without www, a scheme or a trailing slash; HTTP, country subdomains, letter case, surrounding whitespace and tracking parameters are normalized. Unicode and percent-encoded profile names are supported. Existing participants are matched across these formats.", "Person URLs use /in/name or legacy /pub/name/id/id/id paths. A supplied malformed or non-person URL returns HTTP 400. New and updated URLs are stored as https://www.linkedin.com with a trailing slash and without query parameters or fragments.", "POST creates monitoring with HTTP 201 or updates existing monitoring with HTTP 200. status is active or paused. Returns id, company_id, participant_linkedin_id, status, source and credit usage.", "GET lists company monitoring by default; scope=own restricts it to the current user. PATCH and DELETE use /stakeholder/monitoring/{id}; PATCH accepts status, note, source and user_id. DELETE marks the entry DELETED." ], "example": { "linkedin_url": "linkedin.com/in/example-person", "note": "", "source": "upload", "status": "active" } }, { "path": "/stakeholder/monitoring/notifications", "title": "Stakeholder / Monitoring / Notifications", "summary": "Public API endpoint.", "group": "Lead Monitoring", "methods": [ "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "change_type", "detected_at", "field_name", "from", "limit", "new_value", "old_value", "scope", "seen", "source", "stakeholder_monitoring_id", "summary", "to" ], "routePatterns": [ "/stakeholder/monitoring/notifications/{param1}" ], "supportsPathId": false, "notes": [], "example": null }, { "path": "/leads/contact", "title": "Leads / Contact", "summary": "Edit phone or email details for an accessible lead or monitored person.", "group": "Leads", "methods": [ "PATCH" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "monitoring_id", "lead_id", "contact_type", "participant_id", "participant_source", "phone_number", "email" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Identify a monitored person with monitoring_id, or use lead_id and contact_type=company, person or key_contact. person and key_contact also require participant_id. key_contact requires participant_source=linkedin or internal, matching the source returned for that contact.", "Supply phone_number, email or both as text. An empty string clears a value; omitting a field preserves it. Email must be valid and at most 254 bytes; phone_number accepts common phone punctuation and up to 255 bytes.", "Returns status=updated, phone_number and email. Invalid input returns 422; a contact not accessible through the selected lead returns 404; no accessible companies returns 403." ], "example": { "lead_id": 123, "contact_type": "person", "participant_id": 456, "email": "person@example.com" } }, { "path": "/messages", "title": "Messages", "summary": "Submit a support request.", "group": "Messages", "methods": [ "POST" ], "auth": "open", "queryParams": [], "formParams": [ "name", "email", "message", "title" ], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [ "Send form fields name, email and message; title is optional. Returns HTTP 201 with success, id and message." ], "example": null }, { "path": "/notifications", "title": "Notifications", "summary": "Return notifications and support filtering by status.", "group": "Notifications", "methods": [ "DELETE", "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "status" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/notifications/interactions", "title": "Notifications / Interactions", "summary": "Return interaction-based notifications.", "group": "Notifications", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/notifications/interactions/scoreboard", "title": "Notifications / Interactions / Scoreboard", "summary": "Public API endpoint.", "group": "Notifications", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/notifications2", "title": "Notifications2", "summary": "Public API endpoint.", "group": "Notifications", "methods": [ "DELETE", "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "status" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/outreach/workflow", "title": "Outreach / Workflow", "summary": "Public API endpoint.", "group": "Outreach", "methods": [ "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "Notification_id", "pipeline_id", "title", "workflow_id", "workflow_json" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/participants/add", "title": "Participants / Add", "summary": "Public API endpoint.", "group": "Participants", "methods": [ "PATCH", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/participants/fullenrich/email", "title": "Participants / Fullenrich / Email", "summary": "Find and save a participant work email.", "group": "Participants", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "participant_id", "company_id", "company_uid", "source" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Requires participant_id. company_id defaults to an accessible company; source defaults to linkedin and also accepts registry or participants for registry contacts. Returns email, participant_id and enriched. An existing email is returned without a new lookup." ], "example": { "participant_id": 123 } }, { "path": "/partner-accounts", "title": "Partner Accounts", "summary": "Register a partner account and its first customer account.", "group": "Partners", "methods": [ "POST" ], "auth": "open", "queryParams": [], "formParams": [], "jsonParams": [ "name", "company", "email", "locale", "lang", "source" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Send application/json with name, company, email and source. locale defaults to da-DK; lang defaults to the language portion of locale. An optional Idempotency-Key header (8\u2013255 characters) supports retries of the same registration. Success returns 201; conflicting registration returns 409; invalid fields return 422." ], "example": null }, { "path": "/partner-accounts/exchange", "title": "Partner Accounts / Exchange", "summary": "Redeem a partner account link token.", "group": "Partners", "methods": [ "POST" ], "auth": "open", "queryParams": [], "formParams": [], "jsonParams": [ "token", "purpose" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Requires the token and matching purpose from the partner link. No JWT header is required; the link token is required and single-use. Returns success and account; invalid tokens return 401 and already-used or expired link state returns 409." ], "example": null }, { "path": "/partners", "title": "Partners", "summary": "Create or manage partner customers, products, and access settings.", "group": "Partners", "methods": [ "GET", "OPTIONS", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "billing_frequency", "cancel_url", "checkout_required", "company_uid", "connect_linkedin", "create_invoice", "create_subscription", "currency", "customer_email", "customer_name", "kickback_frequency", "linkedin", "linkedin_password", "linkedin_profile_url", "linkedin_username", "monthly_payment", "password", "payment_collection", "products", "send_email", "send_mail", "send_welcome_email", "stripe", "subscription", "subscription_renewal", "subscription_type", "success_url", "trial_days" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/partners/access", "title": "Partners / Access", "summary": "Public API endpoint.", "group": "Partners", "methods": [ "GET", "OPTIONS", "POST" ], "auth": "bearer", "queryParams": [ "token" ], "formParams": [], "jsonParams": [], "routePatterns": [ "/partners/access/{param1}" ], "supportsPathId": false, "notes": [], "example": null }, { "path": "/partners/welcome/password", "title": "Partners / Welcome / Password", "summary": "Public API endpoint.", "group": "Partners", "methods": [ "GET", "POST" ], "auth": "open", "queryParams": [], "formParams": [], "jsonParams": [ "password", "token" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline", "title": "Pipeline", "summary": "Create or manage pipeline configuration.", "group": "Pipeline", "methods": [ "DELETE", "PATCH", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/all/add_single", "title": "Pipeline / All / Add Single", "summary": "Add a single lead to an existing pipeline.", "group": "Pipeline", "methods": [ "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "offset" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/all/leads", "title": "Pipeline / All / Leads", "summary": "List leads in a pipeline with filtering, offset, and limit support.", "group": "Pipeline", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "cache", "day_id", "limit", "offset", "only", "only_with_phone", "pipeline_id", "stage_id", "task_next", "tasks_next", "user_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/all/leads/count", "title": "Pipeline / All / Leads / Count", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "day_id", "limit", "offset", "pipeline_id", "stage_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/all/leads/edit", "title": "Pipeline / All / Leads / Edit", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "pipeline_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/all/leads/people", "title": "Pipeline / All / Leads / People", "summary": "List people in an accessible pipeline or add a person to a people list.", "group": "Pipeline", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "pipeline_id", "page" ], "formParams": [], "jsonParams": [ "pipeline_id", "linkedin_url", "name", "location", "region", "city", "email", "phone_number", "participant_phone2", "job_title", "company_name" ], "routePatterns": [], "supportsPathId": false, "notes": [ "GET requires pipeline_id; page starts at 1 and each page contains up to 100 people. Returns pipeline, columns, pagination and data, including available screening results.", "POST requires pipeline_id and a LinkedIn profile URL in linkedin_url. The destination must be a people list. Optional contact and role fields are shown below. participant_phone2 is the secondary phone field.", "POST returns success, id, pipeline_company_id, participant_id, linkedin_url, job_title, company_name, email and phone_number; HTTP 201 for a new lead or 200 when already present. Invalid fields return 422; a destination that is not a people list returns 409." ], "example": { "pipeline_id": 123, "linkedin_url": "https://www.linkedin.com/in/example-person/", "name": "Example Person" } }, { "path": "/pipeline/all/leads2", "title": "Pipeline / All / Leads2", "summary": "Alternative lead listing endpoint with similar filters.", "group": "Pipeline", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "cache", "day_id", "limit", "offset", "only", "only_with_phone", "pipeline_id", "stage_id", "task_next", "tasks_next", "user_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/delete", "title": "Pipeline / Leads / Delete", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/details", "title": "Pipeline / Leads / Details", "summary": "Return detailed information for a specific pipeline lead.", "group": "Pipeline", "methods": [ "GET", "PATCH" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [ "/pipeline/leads/details/{param1}" ], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/email", "title": "Pipeline / Leads / Email", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "pipeline_id" ], "formParams": [ "pipeline_id" ], "jsonParams": [ "pipeline_id" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/employees", "title": "Pipeline / Leads / Employees", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "id" ], "formParams": [], "jsonParams": [ "id", "pipeline_company_id" ], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/pipeline/leads/financials", "title": "Pipeline / Leads / Financials", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "id" ], "formParams": [], "jsonParams": [ "id", "pipeline_company_id" ], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/pipeline/leads/fullenrich", "title": "Pipeline / Leads / Fullenrich", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/notes", "title": "Pipeline / Leads / Notes", "summary": "Read or update notes on a pipeline lead.", "group": "Pipeline", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "id" ], "formParams": [], "jsonParams": [ "id", "pipeline_company_id" ], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/pipeline/leads/outreach", "title": "Pipeline / Leads / Outreach", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "pipeline_id", "stage" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/owner", "title": "Pipeline / Leads / Owner", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "PATCH" ], "auth": "bearer", "queryParams": [ "id" ], "formParams": [], "jsonParams": [ "id", "pipeline_company_id" ], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/pipeline/leads/people", "title": "Pipeline / Leads / People", "summary": "Alias of /pipeline/all/leads/people for listing and adding people.", "group": "Pipeline", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "pipeline_id", "page" ], "formParams": [], "jsonParams": [ "pipeline_id", "linkedin_url", "name", "location", "region", "city", "email", "phone_number", "participant_phone2", "job_title", "company_name" ], "routePatterns": [], "supportsPathId": false, "notes": [ "GET requires pipeline_id; page starts at 1 and each page contains up to 100 people. Returns pipeline, columns, pagination and data, including available screening results.", "POST requires pipeline_id and a LinkedIn profile URL in linkedin_url. The destination must be a people list. Optional contact and role fields are shown below. participant_phone2 is the secondary phone field.", "POST returns success, id, pipeline_company_id, participant_id, linkedin_url, job_title, company_name, email and phone_number; HTTP 201 for a new lead or 200 when already present. Invalid fields return 422; a destination that is not a people list returns 409." ], "example": { "pipeline_id": 123, "linkedin_url": "https://www.linkedin.com/in/example-person/", "name": "Example Person" } }, { "path": "/pipeline/leads/search", "title": "Pipeline / Leads / Search", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "company_name" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/stage", "title": "Pipeline / Leads / Stage", "summary": "Move a lead to another stage.", "group": "Pipeline", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "pipeline_company_id", "stage_id" ], "routePatterns": [ "/pipeline/leads/stage/{param1}" ], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/status", "title": "Pipeline / Leads / Status", "summary": "Update lead status and an optional reason.", "group": "Pipeline", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "pipeline_company_id", "reason", "status" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/leads/todo", "title": "Pipeline / Leads / Todo", "summary": "Read or manage lead-level todo items.", "group": "Pipeline", "methods": [ "DELETE", "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "body", "completed", "deadline", "id", "tid", "title" ], "routePatterns": [ "/pipeline/leads/todo/{param1}" ], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/list", "title": "Pipeline / List", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "GET" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/pipeline/list/queue", "title": "Pipeline / List / Queue", "summary": "Public API endpoint.", "group": "Pipeline", "methods": [ "PATCH" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/plugins", "title": "Plugins", "summary": "Public API endpoint.", "group": "Plugins", "methods": [ "GET" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/plugins/details", "title": "Plugins / Details", "summary": "Return or update plugin configuration details.", "group": "Plugins", "methods": [ "GET", "PATCH" ], "auth": "bearer", "queryParams": [ "id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/plugins/details/fields", "title": "Plugins / Details / Fields", "summary": "Public API endpoint.", "group": "Plugins", "methods": [ "GET", "PATCH" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/plugins/dripify/accounts", "title": "Plugins / Dripify / Accounts", "summary": "Create or fetch Dripify accounts.", "group": "Plugins", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "password", "username" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/plugins/dripify/list", "title": "Plugins / Dripify / List", "summary": "List or store Dripify mappings and selections.", "group": "Plugins", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "id", "pipeline_id" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/plugins/sales_insider/introductions", "title": "Plugins / Sales Insider / Introductions", "summary": "Manage introduction preferences, ideal customer profiles and introduction requests.", "group": "Plugins", "methods": [ "GET", "POST", "PUT", "DELETE" ], "auth": "bearer", "queryParams": [ "action", "q", "icp_id", "participant_id", "introducer_id" ], "formParams": [], "jsonParams": [ "description", "star_urls", "importance", "creation_key", "id", "version", "participant_ids", "target_id", "introducer_id", "icp_id", "icp_version", "message", "idempotency_key" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Select the operation with the action query parameter. GET supports overview (default), account, onboarding-status, onboarding, icps, contacts, missing-introducers and opportunity. contacts accepts q; opportunity requires icp_id, participant_id and introducer_id. Access requires authenticated company membership.", "POST action=onboarding requires description (1\u20138000 characters) and star_urls containing exactly five different LinkedIn profile URLs, plus a connected LinkedIn account.", "POST action=icps creates an ideal customer profile using description (1\u20138000 characters), importance (integer 1\u201310) and creation_key (16\u201380 letters, digits, underscores or hyphens). PUT action=icps edits it using id and version in place of creation_key; DELETE action=icps requires id and version.", "PUT action=stars saves participant_ids. POST action=remove removes target_id. POST action=schedule requires target_id, introducer_id, icp_id, icp_version, message and idempotency_key, and returns HTTP 201 with request. Reuse the idempotency key only for the same request.", "Invalid input returns 422, a stale profile or unavailable introduction returns 409, and an unknown action or missing opportunity returns 404." ], "example": null }, { "path": "/prospecting", "title": "Prospecting", "summary": "Search people or companies with contact, company and data freshness filters.", "group": "Prospecting", "methods": [ "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "filters", "view", "page" ], "routePatterns": [], "supportsPathId": false, "notes": [ "Send a JSON object. view is people (default) or companies; page is an integer from 1 to 10000 (default 1). Results contain up to 50 items per page.", "filters accepts name, job_title, location, company, exclude_company, website, industry and company_country as comma- or newline-separated text. Each filter permits up to 10 values, 150 bytes per value and 1000 bytes overall. Different filters combine; values within one filter are alternatives.", "Numeric filters: employees_min and employees_max are nonnegative integers; company_id is a positive LinkedIn company identifier. followers accepts a nonnegative integer for an exact count or an inclusive string range such as 10-500; reversed range endpoints are automatically ordered and a trailing dash (such as 100-) is treated as the exact count. Profiles with no stored count are treated as 0. Blank or null numeric filters are ignored. quality is an array of A, B, C, D, E or F. A is updated within 30 days, B within 90, C within 180, D within 270, E within 365; F covers older or unknown freshness.", "Returns items, total, page, page_size, view and normalized filters. People include id, name, image, phonenumber, email, linkedin_url, location, city, region, last_updated, job_title, company_id, company_name, website, company_country, employees, age_days and data_quality. Company results include company_id, company_name, website, company_country, employees and people_count.", "image may be an HTTP(S) URL or a filename resolved under https://api.coherta.com/images/. Invalid filters return 422; an unavailable search returns 503." ], "example": { "view": "people", "page": 1, "filters": { "job_title": "CEO, Founder", "company_country": "Denmark", "quality": [ "A", "B" ] } } }, { "path": "/recruiters", "title": "Recruiters", "summary": "Public API endpoint.", "group": "Recruiters", "methods": [ "DELETE", "GET", "PATCH", "POST" ], "auth": "bearer", "queryParams": [ "id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/recruiters/cv", "title": "Recruiters / Cv", "summary": "Public API endpoint.", "group": "Recruiters", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "candidate_id", "id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": true, "notes": [], "example": null }, { "path": "/search", "title": "Search", "summary": "Search across indexed data using the q query parameter.", "group": "Search", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "dead", "q" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/company/updates", "title": "Users / Company / Updates", "summary": "Public API endpoint.", "group": "Users", "methods": [ "GET" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/create", "title": "Users / Create", "summary": "Create a user through the public sign-up flow.", "group": "Users", "methods": [ "POST" ], "auth": "open", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/me", "title": "Users / Me", "summary": "Read or update the authenticated user profile.", "group": "Users", "methods": [ "GET", "PATCH" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "email", "full_name", "password", "welcome_screen" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/me/billing", "title": "Users / Me / Billing", "summary": "Get a subscription quote, begin checkout or check a checkout result.", "group": "Users", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "flow", "product" ], "formParams": [], "jsonParams": [ "action", "flow", "product", "quote_id", "checkout_reference" ], "routePatterns": [], "supportsPathId": false, "notes": [ "GET requires flow=upgrade or startups; upgrades also specify product. Returns quote with the current offer and quote_id.", "POST action=checkout requires flow, the same product where applicable and the quote_id from GET. A changed offer returns 409; refresh the quote before retrying. The response contains checkout for payment or scheduled and message for a scheduled change.", "POST action=status requires flow and checkout_reference from the checkout. Invalid input returns 422; billing service failures return 502." ], "example": null }, { "path": "/users/me/companies", "title": "Users / Me / Companies", "summary": "Return or update the companies available to the current user.", "group": "Users", "methods": [ "GET", "PATCH" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/me/companies/access_rights", "title": "Users / Me / Companies / Access Rights", "summary": "Return or update company access rights for a user.", "group": "Users", "methods": [ "GET", "OPTIONS", "PATCH" ], "auth": "bearer", "queryParams": [ "user_id" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/me/company_activity", "title": "Users / Me / Company Activity", "summary": "Read a paginated activity feed for the current company.", "group": "Users", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "category", "from", "to", "cursor" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [ "category is all (default), campaigns, leads, crm, tasks or workflows. from and to are optional YYYY-MM-DD dates, inclusive. Pass the returned next_cursor unchanged to fetch the next page.", "Returns company, events and next_cursor, with up to 50 activities ordered newest first. next_cursor is null on the last page. Invalid category, date range or cursor returns 422; no accessible account returns 403; an unavailable feed returns 503." ], "example": null }, { "path": "/users/me/linkedin", "title": "Users / Me / Linkedin", "summary": "Public API endpoint.", "group": "Users", "methods": [ "PATCH", "POST" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/me/subscription_center", "title": "Users / Me / Subscription Center", "summary": "Read the current subscription, start checkout or stop renewal.", "group": "Users", "methods": [ "GET", "POST" ], "auth": "bearer", "queryParams": [ "view", "company_id" ], "formParams": [], "jsonParams": [ "action", "return_to", "checkout_reference", "confirm", "expected_subscription_id", "expected_deal_id", "expected_payment_subscription_id" ], "routePatterns": [], "supportsPathId": false, "notes": [ "GET returns subscription and checkout_state. view=gate requests account access status; company_id is only used with view=gate and must identify an accessible account.", "POST action=start begins checkout; return_to accepts app (default) or subscription_center. action=checkout_status checks checkout_reference. action=start_revolut_from_stripe starts an eligible payment-provider migration.", "POST action=stop requires confirm=true, expected_subscription_id, expected_deal_id and expected_payment_subscription_id copied from subscription.subscription_id, subscription.deal_id and subscription.payment_subscription_id. Refresh subscription details before retrying a 409 conflict. Partner-managed prepaid subscriptions support GET; changes return 409." ], "example": null }, { "path": "/users/password/forgot", "title": "Users / Password / Forgot", "summary": "Start the password reset flow.", "group": "Users", "methods": [ "POST" ], "auth": "open", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/todo", "title": "Users / Todo", "summary": "Public API endpoint.", "group": "Users", "methods": [ "DELETE", "GET", "PATCH" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [ "body", "completed", "deadline", "id", "tid", "title" ], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/users/todo/overview", "title": "Users / Todo / Overview", "summary": "Public API endpoint.", "group": "Users", "methods": [ "GET" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/zapier/notifications", "title": "Zapier / Notifications", "summary": "Public API endpoint.", "group": "Zapier", "methods": [ "GET" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/zapier/notifications/interactions", "title": "Zapier / Notifications / Interactions", "summary": "Public API endpoint.", "group": "Zapier", "methods": [ "GET" ], "auth": "bearer", "queryParams": [], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null }, { "path": "/zapier/pipeline/all/leads", "title": "Zapier / Pipeline / All / Leads", "summary": "Public API endpoint.", "group": "Zapier", "methods": [ "GET" ], "auth": "bearer", "queryParams": [ "offset" ], "formParams": [], "jsonParams": [], "routePatterns": [], "supportsPathId": false, "notes": [], "example": null } ] }