Coherta API Reference
Reference

Search and filter the public API

Browse endpoint groups on the left, inspect routes in the center, and keep quick integration notes visible on the right while you work.

100 endpoints 86 protected 22 groups

Auth

Expand any route to see common query, form, JSON, and path details for this part of the API.

1 endpoints

Auth / Google

Handle the Google OAuth callback flow.

/auth/google
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

affiliate, bo_affiliate, code, error, error_description, return_url, source, state, stripe_enabled, transactionid

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Authentication

Expand any route to see common query, form, JSON, and path details for this part of the API.

2 endpoints

Token

Exchange a username and password for a JWT access token.

/token
POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

password, username

JSON fields

password, username

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Token / Renew

Refresh an existing bearer token and receive a new JWT.

/token/renew
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Campaigns

Expand any route to see common query, form, JSON, and path details for this part of the API.

17 endpoints

Campaigns

List or manage campaigns.

/campaigns
DELETE GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Campaigns / Attached Contacts

Public API endpoint.

/campaigns/attached_contacts
GET PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

campaign_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Campaigns / Connected Contacts

Public API endpoint.

/campaigns/connected_contacts
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

campaign_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Campaigns / Employee Settings

Public API endpoint.

/campaigns/employee_settings
DELETE GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

employee_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Campaigns / Lead Exists

Check whether a LinkedIn profile belongs to an active campaign in an accessible company.

/campaigns/lead_exists
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

linkedin_url

Form fields

No common fields listed.

JSON fields

linkedin_url

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

Requires linkedin_url (linkedin is an alias). Returns a JSON boolean. A missing or invalid profile URL returns 400.

Campaigns / Linked Posts

List or save LinkedIn posts associated with a campaign.

/campaigns/linked_posts
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

campaign_id

Form fields

No common fields listed.

JSON fields

campaign_id, urn, external_post_id, post_url, author_urn, author_name, post_text, published_at

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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.

Campaigns / Lists

Save a prospecting search, qualify selected people, or start and poll LinkedIn discovery.

/campaigns/lists
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

discovery_campaign_id, page

Form fields

No common fields listed.

JSON fields

action, title, filters, view, request_id, campaign_id, participant_ids, discovery_campaign_id, screening_context, outreach, first_message, employee_title, country

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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–150 characters), filters using the /prospecting shape, and request_id (16–80 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–500 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–200 characters), country (1–100 characters) and screening_context (1–10000 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 JSON request

Replace example identifiers with values from your account.

{
    "action": "save",
    "title": "Danish founders",
    "filters": {
        "job_title": "Founder",
        "company_country": "Denmark"
    },
    "view": "people",
    "request_id": "example-save-request-0001"
}

Campaigns / Lists / Contact

Find an email address or phone number for a prospecting participant.

/campaigns/lists/contact
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

participant_id, field

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "participant_id": 123,
    "field": "email"
}

Campaigns / Lists / People

Add selected people directly to a lead list or existing campaign.

/campaigns/lists/people
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

request_id

Form fields

No common fields listed.

JSON fields

action, request_id, participant_ids, pipeline_id, campaign_id, title, enrich_phone, enrich_email

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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–80 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–150 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 JSON request

Replace example identifiers with values from your account.

{
    "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"
}

Campaigns / Messages

Return campaign messages and related threads.

/campaigns/messages
DELETE GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

campaign_id, employee_id, message_id, mode, thread_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Campaigns / Messages / Access

Public API endpoint.

/campaigns/messages/access
GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

accept_id, accept_token, access_graned_to, access_granted_to, action, granted_to_user_id, id, owner_user_id, request_token, token, user_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Campaigns / Messages / Search

Search an accessible employee inbox for people and messages.

/campaigns/messages/search
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

employee_id, scope, query, limit

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

Requires positive employee_id, scope=everything, person or message, and query (2–200 characters). limit defaults to 50 and is capped at 50. Returns results. Validation errors return 422; an inaccessible inbox returns 403.

Campaigns / Settings

Public API endpoint.

/campaigns/settings
DELETE GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

campaign_id, scope

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Campaigns / Statistics

Return campaign statistics for a date range or employee.

/campaigns/statistics
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

campaign_id, date_from, date_to, employee_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Campaigns / Workflow / Attached

List campaign contacts currently in a workflow, including screening results.

/campaigns/workflow/attached
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

campaign_id, scope

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Usage and responses

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.

Campaigns / Workflow / Continue

Move a campaign lead from its current workflow node to the next node.

/campaigns/workflow/continue
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

campaign_id, lead_id, current_node_id, next_node_id, user_id, linkedin_url

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "campaign_id": 123,
    "lead_id": 456,
    "current_node_id": "screening"
}

Campaigns / Workflow / Stop

Stop the workflow for a campaign lead.

/campaigns/workflow/stop
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

campaign_id, lead_id, current_node_id, next_node_id, user_id, linkedin_url

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "campaign_id": 123,
    "lead_id": 456,
    "current_node_id": "screening"
}

Company

Expand any route to see common query, form, JSON, and path details for this part of the API.

2 endpoints

Company / Employees / Monthly

Public API endpoint.

/company/employees/monthly
GET Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

company_uid

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Company / Users

List users associated with a company.

/company/users
GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.
Path patterns: /company/users , /company/users/{param1}

Dashboard

Expand any route to see common query, form, JSON, and path details for this part of the API.

2 endpoints

Dashboard / Linkedin

Read LinkedIn activity and audience metrics for a personal profile or company page.

/dashboard/linkedin
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

scope, days, page_id, company_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

scope defaults to personal; use company for a company page. days defaults to 28 and is clamped to 7–365. For company scope, page_id (or company_id) selects an accessible LinkedIn page.

Dashboard / Overview

Provide dashboard overview data.

/dashboard/overview
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Filters

Expand any route to see common query, form, JSON, and path details for this part of the API.

8 endpoints

Filter / Company

Filter companies using the classic company filter set.

/filter/company
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Filter / Company / Categories

Public API endpoint.

/filter/company/categories
GET Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

t

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Filter / Company / Guests

Public API endpoint.

/filter/company/guests
POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Filter / Company / Phonenumbers

Public API endpoint.

/filter/company/phonenumbers
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Filter / Company New

Filter companies using the newer filtering engine.

/filter/company_new
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Filter / Company New2

Alternative company filtering endpoint using the newer model.

/filter/company_new2
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Filter / Field / Mapping

Public API endpoint.

/filter/field/mapping
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Filter / People

Find people based on filter criteria.

/filter/people
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

GTM

Expand any route to see common query, form, JSON, and path details for this part of the API.

3 endpoints

Gtm / Templates

Public API endpoint.

/gtm/templates
GET Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

featured, id, search

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Gtm / Templates / Sample

Public API endpoint.

/gtm/templates/sample
GET Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

list_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Gtm / Templates / Sample / Company Data

Public API endpoint.

/gtm/templates/sample/company_data
GET Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

country_code, domain_id, list_id, vat_code

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Introductions

Expand any route to see common query, form, JSON, and path details for this part of the API.

1 endpoints

Introductions / Signup

Create an account for Get an Introduction.

/introductions/signup
POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

name, email, password

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

Requires name (up to 120 characters), a valid email (up to 254 bytes) and password (12–72 bytes). Send JSON, up to 16 KiB. Validation errors return 422 and rate limits return 429.

Lead Monitoring

Expand any route to see common query, form, JSON, and path details for this part of the API.

2 endpoints

Stakeholder / Monitoring

List, add, update or remove stakeholder monitoring for an accessible company.

/stakeholder/monitoring
GET POST PATCH DELETE Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

company_id, scope, status

Form fields

No common fields listed.

JSON fields

company_id, participant_linkedin_id, linkedin_url, participant_linkedin, name, email, phonenumber, phonenumber_2, status, note, source, user_id

Additional notes

No alternate path-style id pattern is listed for this endpoint.
Path patterns: /stakeholder/monitoring/{param1}

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "linkedin_url": "linkedin.com/in/example-person",
    "note": "",
    "source": "upload",
    "status": "active"
}

Stakeholder / Monitoring / Notifications

Public API endpoint.

/stakeholder/monitoring/notifications
GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

change_type, detected_at, field_name, from, limit, new_value, old_value, scope, seen, source, stakeholder_monitoring_id, summary, to

Additional notes

No alternate path-style id pattern is listed for this endpoint.
Path patterns: /stakeholder/monitoring/notifications/{param1}

Leads

Expand any route to see common query, form, JSON, and path details for this part of the API.

1 endpoints

Leads / Contact

Edit phone or email details for an accessible lead or monitored person.

/leads/contact
PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

monitoring_id, lead_id, contact_type, participant_id, participant_source, phone_number, email

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "lead_id": 123,
    "contact_type": "person",
    "participant_id": 456,
    "email": "person@example.com"
}

Messages

Expand any route to see common query, form, JSON, and path details for this part of the API.

1 endpoints

Messages

Submit a support request.

/messages
POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

name, email, message, title

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

Send form fields name, email and message; title is optional. Returns HTTP 201 with success, id and message.

Notifications

Expand any route to see common query, form, JSON, and path details for this part of the API.

4 endpoints

Notifications

Return notifications and support filtering by status.

/notifications
DELETE GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

status

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Notifications / Interactions

Return interaction-based notifications.

/notifications/interactions
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Notifications / Interactions / Scoreboard

Public API endpoint.

/notifications/interactions/scoreboard
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Notifications2

Public API endpoint.

/notifications2
DELETE GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

status

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Outreach

Expand any route to see common query, form, JSON, and path details for this part of the API.

1 endpoints

Outreach / Workflow

Public API endpoint.

/outreach/workflow
GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

Notification_id, pipeline_id, title, workflow_id, workflow_json

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Participants

Expand any route to see common query, form, JSON, and path details for this part of the API.

2 endpoints

Participants / Add

Public API endpoint.

/participants/add
PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Participants / Fullenrich / Email

Find and save a participant work email.

/participants/fullenrich/email
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

participant_id, company_id, company_uid, source

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "participant_id": 123
}

Partners

Expand any route to see common query, form, JSON, and path details for this part of the API.

5 endpoints

Partner Accounts

Register a partner account and its first customer account.

/partner-accounts
POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

name, company, email, locale, lang, source

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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–255 characters) supports retries of the same registration. Success returns 201; conflicting registration returns 409; invalid fields return 422.

Partner Accounts / Exchange

Redeem a partner account link token.

/partner-accounts/exchange
POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

token, purpose

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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.

Partners

Create or manage partner customers, products, and access settings.

/partners
GET OPTIONS POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

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

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Partners / Access

Public API endpoint.

/partners/access
GET OPTIONS POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

token

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.
Path patterns: /partners/access/{param1}

Partners / Welcome / Password

Public API endpoint.

/partners/welcome/password
GET POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

password, token

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline

Expand any route to see common query, form, JSON, and path details for this part of the API.

23 endpoints

Pipeline

Create or manage pipeline configuration.

/pipeline
DELETE PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / All / Add Single

Add a single lead to an existing pipeline.

/pipeline/all/add_single
PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

offset

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / All / Leads

List leads in a pipeline with filtering, offset, and limit support.

/pipeline/all/leads
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

cache, day_id, limit, offset, only, only_with_phone, pipeline_id, stage_id, task_next, tasks_next, user_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / All / Leads / Count

Public API endpoint.

/pipeline/all/leads/count
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

day_id, limit, offset, pipeline_id, stage_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / All / Leads / Edit

Public API endpoint.

/pipeline/all/leads/edit
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

pipeline_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / All / Leads / People

List people in an accessible pipeline or add a person to a people list.

/pipeline/all/leads/people
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

pipeline_id, page

Form fields

No common fields listed.

JSON fields

pipeline_id, linkedin_url, name, location, region, city, email, phone_number, participant_phone2, job_title, company_name

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "pipeline_id": 123,
    "linkedin_url": "https://www.linkedin.com/in/example-person/",
    "name": "Example Person"
}

Pipeline / All / Leads2

Alternative lead listing endpoint with similar filters.

/pipeline/all/leads2
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

cache, day_id, limit, offset, only, only_with_phone, pipeline_id, stage_id, task_next, tasks_next, user_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / Leads / Delete

Public API endpoint.

/pipeline/leads/delete
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / Leads / Details

Return detailed information for a specific pipeline lead.

/pipeline/leads/details
GET PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.
Path patterns: /pipeline/leads/details/{param1}

Pipeline / Leads / Email

Public API endpoint.

/pipeline/leads/email
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

pipeline_id

Form fields

pipeline_id

JSON fields

pipeline_id

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / Leads / Employees

Public API endpoint.

/pipeline/leads/employees
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

id

Form fields

No common fields listed.

JSON fields

id, pipeline_company_id

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Pipeline / Leads / Financials

Public API endpoint.

/pipeline/leads/financials
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

id

Form fields

No common fields listed.

JSON fields

id, pipeline_company_id

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Pipeline / Leads / Fullenrich

Public API endpoint.

/pipeline/leads/fullenrich
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / Leads / Notes

Read or update notes on a pipeline lead.

/pipeline/leads/notes
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

id

Form fields

No common fields listed.

JSON fields

id, pipeline_company_id

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Pipeline / Leads / Outreach

Public API endpoint.

/pipeline/leads/outreach
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

pipeline_id, stage

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / Leads / Owner

Public API endpoint.

/pipeline/leads/owner
PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

id

Form fields

No common fields listed.

JSON fields

id, pipeline_company_id

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Pipeline / Leads / People

Alias of /pipeline/all/leads/people for listing and adding people.

/pipeline/leads/people
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

pipeline_id, page

Form fields

No common fields listed.

JSON fields

pipeline_id, linkedin_url, name, location, region, city, email, phone_number, participant_phone2, job_title, company_name

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "pipeline_id": 123,
    "linkedin_url": "https://www.linkedin.com/in/example-person/",
    "name": "Example Person"
}

Pipeline / Leads / Search

Public API endpoint.

/pipeline/leads/search
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

company_name

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / Leads / Stage

Move a lead to another stage.

/pipeline/leads/stage
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

pipeline_company_id, stage_id

Additional notes

No alternate path-style id pattern is listed for this endpoint.
Path patterns: /pipeline/leads/stage/{param1}

Pipeline / Leads / Status

Update lead status and an optional reason.

/pipeline/leads/status
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

pipeline_company_id, reason, status

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / Leads / Todo

Read or manage lead-level todo items.

/pipeline/leads/todo
DELETE GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

body, completed, deadline, id, tid, title

Additional notes

No alternate path-style id pattern is listed for this endpoint.
Path patterns: /pipeline/leads/todo/{param1}

Pipeline / List

Public API endpoint.

/pipeline/list
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Pipeline / List / Queue

Public API endpoint.

/pipeline/list/queue
PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Plugins

Expand any route to see common query, form, JSON, and path details for this part of the API.

6 endpoints

Plugins

Public API endpoint.

/plugins
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Plugins / Details

Return or update plugin configuration details.

/plugins/details
GET PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Plugins / Details / Fields

Public API endpoint.

/plugins/details/fields
GET PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Plugins / Dripify / Accounts

Create or fetch Dripify accounts.

/plugins/dripify/accounts
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

password, username

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Plugins / Dripify / List

List or store Dripify mappings and selections.

/plugins/dripify/list
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

id, pipeline_id

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Plugins / Sales Insider / Introductions

Manage introduction preferences, ideal customer profiles and introduction requests.

/plugins/sales_insider/introductions
GET POST PUT DELETE Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

action, q, icp_id, participant_id, introducer_id

Form fields

No common fields listed.

JSON fields

description, star_urls, importance, creation_key, id, version, participant_ids, target_id, introducer_id, icp_id, icp_version, message, idempotency_key

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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–8000 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–8000 characters), importance (integer 1–10) and creation_key (16–80 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.

Prospecting

Expand any route to see common query, form, JSON, and path details for this part of the API.

1 endpoints

Prospecting

Search people or companies with contact, company and data freshness filters.

/prospecting
POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

filters, view, page

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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 JSON request

Replace example identifiers with values from your account.

{
    "view": "people",
    "page": 1,
    "filters": {
        "job_title": "CEO, Founder",
        "company_country": "Denmark",
        "quality": [
            "A",
            "B"
        ]
    }
}

Recruiters

Expand any route to see common query, form, JSON, and path details for this part of the API.

2 endpoints

Recruiters

Public API endpoint.

/recruiters
DELETE GET PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Recruiters / Cv

Public API endpoint.

/recruiters/cv
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

candidate_id, id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

This endpoint also supports a path-style id in the final URL segment, in addition to ?id=....

Users

Expand any route to see common query, form, JSON, and path details for this part of the API.

12 endpoints

Users / Company / Updates

Public API endpoint.

/users/company/updates
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Users / Create

Create a user through the public sign-up flow.

/users/create
POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Users / Me

Read or update the authenticated user profile.

/users/me
GET PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

email, full_name, password, welcome_screen

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Users / Me / Billing

Get a subscription quote, begin checkout or check a checkout result.

/users/me/billing
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

flow, product

Form fields

No common fields listed.

JSON fields

action, flow, product, quote_id, checkout_reference

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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.

Users / Me / Companies

Return or update the companies available to the current user.

/users/me/companies
GET PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Users / Me / Companies / Access Rights

Return or update company access rights for a user.

/users/me/companies/access_rights
GET OPTIONS PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

user_id

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Users / Me / Company Activity

Read a paginated activity feed for the current company.

/users/me/company_activity
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

category, from, to, cursor

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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.

Users / Me / Linkedin

Public API endpoint.

/users/me/linkedin
PATCH POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Users / Me / Subscription Center

Read the current subscription, start checkout or stop renewal.

/users/me/subscription_center
GET POST Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

view, company_id

Form fields

No common fields listed.

JSON fields

action, return_to, checkout_reference, confirm, expected_subscription_id, expected_deal_id, expected_payment_subscription_id

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Usage and responses

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.

Users / Password / Forgot

Start the password reset flow.

/users/password/forgot
POST Open endpoint
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Users / Todo

Public API endpoint.

/users/todo
DELETE GET PATCH Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

body, completed, deadline, id, tid, title

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Users / Todo / Overview

Public API endpoint.

/users/todo/overview
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Zapier

Expand any route to see common query, form, JSON, and path details for this part of the API.

3 endpoints

Zapier / Notifications

Public API endpoint.

/zapier/notifications
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Zapier / Notifications / Interactions

Public API endpoint.

/zapier/notifications/interactions
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

No common fields listed.

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Zapier / Pipeline / All / Leads

Public API endpoint.

/zapier/pipeline/all/leads
GET Bearer required
Interactive testing

Open a request builder for this specific endpoint and run it directly from the browser.

Query fields

offset

Form fields

No common fields listed.

JSON fields

No common fields listed.

Additional notes

No alternate path-style id pattern is listed for this endpoint.

Use the separate overview page for authentication onboarding and live token validation, then use this reference page to search routes and inspect request fields in detail.