C
Coherta API Reference Searchable endpoint documentation
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.

122 endpoints 83 protected 34 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

code, error, error_description, state

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.

Cache

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

1 endpoints

Cache / Pipeline

Public API endpoint.

/cache/pipeline
GET Open endpoint
Interactive testing

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

Query fields

only, only_with_phone, pipeline_id, task_next, tasks_next

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.

10 endpoints

Campaigns

List or manage campaigns.

/campaigns
GET 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

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 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 / Bootstrap

Public API endpoint.

/campaigns/bootstrap
POST 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.

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 / Contacts Leads

Public API endpoint.

/campaigns/contacts_leads
Unspecified 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.

Campaigns / Employee Settings

Public API endpoint.

/campaigns/employee_settings
GET Open endpoint
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 / Messages

Return campaign messages and related threads.

/campaigns/messages
GET Open endpoint
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 Open endpoint
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, 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 / Settings

Public API endpoint.

/campaigns/settings
GET Open endpoint
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 Open endpoint
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.

Coherta Admin

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

1 endpoints

Coherta Admin

Public API endpoint.

/coherta_admin
POST 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.

Cohertus

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

2 endpoints

Cohertus / Filtering

Public API endpoint.

/cohertus/filtering
POST 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

cohertus_slack, description, thread_id

Additional notes

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

Cohertus / Old

Public API endpoint.

/cohertus/old
POST 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

description

Additional notes

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

Cohertus Slack

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

1 endpoints

Cohertus Slack

Public API endpoint.

/cohertus_slack
POST 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

cohertus_slack, description, thread_id

Additional notes

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

Company

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

11 endpoints

Company / Details

Public API endpoint.

/company/details
Unspecified 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/details/{param1}

Company / Details / {id}

Public API endpoint.

/company/details/{id}
Unspecified 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.

Company / Employees

Public API endpoint.

/company/employees
GET POST 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

id, pipeline_company_id

Additional notes

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

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 / Financials

Public API endpoint.

/company/financials
GET POST 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

id, pipeline_company_id

Additional notes

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

Company / Financials / Collect

Public API endpoint.

/company/financials/collect
Unspecified 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.

Company / Notes

Public API endpoint.

/company/notes
GET POST 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

id, pipeline_company_id

Additional notes

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

Company / Stage

Public API endpoint.

/company/stage
POST 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

pipeline_company_id, stage_id

Additional notes

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

Company / Stages

Public API endpoint.

/company/stages
POST 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

pipeline_company_id, stage_id

Additional notes

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

Company / Todo

Public API endpoint.

/company/todo
POST 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, tid, title

Additional notes

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

Company / Users

List users associated with a company.

/company/users
POST 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: /company/users , /company/users/{param1}

Company Employees

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

1 endpoints

Company Employees

Public API endpoint.

/company_employees
GET POST 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

id, pipeline_company_id

Additional notes

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

Dashboard

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

1 endpoints

Dashboard / Overview

Provide dashboard overview data.

/dashboard/overview
Unspecified 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.

Database Mapping

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

1 endpoints

Database Mapping

Public API endpoint.

/database_mapping
Unspecified 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.

Docs

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

1 endpoints

Docs

Public API endpoint.

/docs
Unspecified 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.

Filters

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

12 endpoints

Filter / Company

Filter companies using the classic company filter set.

/filter/company
POST 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.

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 / Company2

Public API endpoint.

/filter/company2
POST 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.

Filter / Company Categories

Public API endpoint.

/filter/company_categories
Unspecified 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 New

Filter companies using the newer filtering engine.

/filter/company_new
POST 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.

Filter / Company New2

Alternative company filtering endpoint using the newer model.

/filter/company_new2
POST 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.

Filter / Field / Mapping

Public API endpoint.

/filter/field/mapping
Unspecified 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
POST 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.

Filter / People

Find people based on filter criteria.

/filter/people
POST 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.

Filter Function

Public API endpoint.

/filter_function
Unspecified 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.

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, 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.

Index2

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

1 endpoints

Index2

Public API endpoint.

/index2
OPTIONS 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

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

Leads Outreach

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

1 endpoints

Leads Outreach

Public API endpoint.

/leads-outreach
GET POST PATCH 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

initial_message, message_delay, outreach_owner_id, pipeline_id, status, systemprompt

Additional notes

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

LinkedIn

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

1 endpoints

Linkedin / Create

Public API endpoint.

/linkedin/create
Unspecified 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.

Maintenance

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

2 endpoints

Temp Fix

Public API endpoint.

/temp_fix
Unspecified 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.

Test Workflow

Public API endpoint.

/test-workflow
Unspecified 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.

Messages

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

1 endpoints

Messages

Public API endpoint.

/messages
Unspecified 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.

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
GET POST PATCH 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
POST 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.

Notifications / Interactions / Scoreboard

Public API endpoint.

/notifications/interactions/scoreboard
POST 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.

Notifications2

Public API endpoint.

/notifications2
GET POST PATCH 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
POST 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

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 / Add / Linkedin

Public API endpoint.

/participants/add/linkedin
PATCH 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.

Partners

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

2 endpoints

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

access_to_customer_profile, company_uid, customer_email, customer_name, kickback_frequency, monthly_payment, other_customer_emails_to_invite, products, trial, who_pays

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}

Pipeline

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

31 endpoints

Pipeline

Create or manage pipeline configuration.

/pipeline
POST 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.

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 / Sync

Public API endpoint.

/pipeline/all/leads/sync
PATCH 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 / Sync Crm

Public API endpoint.

/pipeline/all/leads/sync_crm
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 / 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 / All / Leadsn

Public API endpoint.

/pipeline/all/leadsn
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 / Delete

Public API endpoint.

/pipeline/delete
POST 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.

Pipeline / Leads / Delete

Public API endpoint.

/pipeline/leads/delete
POST 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.

Pipeline / Leads / Details

Return detailed information for a specific pipeline lead.

/pipeline/leads/details
POST 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 POST 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

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 / Enrich / Leads

Public API endpoint.

/pipeline/leads/enrich/leads
POST PATCH 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.

Pipeline / Leads / Financials

Public API endpoint.

/pipeline/leads/financials
GET POST 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

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 / Lost

Public API endpoint.

/pipeline/leads/lost
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 / Notes

Read or update notes on a pipeline lead.

/pipeline/leads/notes
GET POST 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

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
GET POST 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

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 / 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 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

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
POST 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.
Path patterns: /pipeline/leads/todo/{param1}

Pipeline / Leads / Won

Public API endpoint.

/pipeline/leads/won
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 Fullenrich

Public API endpoint.

/pipeline/leads_fullenrich
Unspecified 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.

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.

Pipeline / Sync

Public API endpoint.

/pipeline/sync
PATCH 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 / Updater

Public API endpoint.

/pipeline/updater
GET Open endpoint
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 Leads

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

1 endpoints

Pipeline Leads / Notes

Public API endpoint.

/pipeline_leads/notes
GET POST 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

id, pipeline_company_id

Additional notes

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

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

No common fields listed.

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 / Mapping

Public API endpoint.

/plugins/mapping
Unspecified 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.

Plugins Fields

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

1 endpoints

Plugins Fields

Public API endpoint.

/plugins_fields
Unspecified 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.

Plugins Mapping

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

1 endpoints

Plugins Mapping

Public API endpoint.

/plugins_mapping
Unspecified 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.

Send Email

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

1 endpoints

Send Email

Public API endpoint.

/send_email
GET Open endpoint
Interactive testing

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

Query fields

code, state

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.

Send Login

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

1 endpoints

Send Login

Public API endpoint.

/send_login
Unspecified 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.

Signal

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

1 endpoints

Signal

Public API endpoint.

/signal
Unspecified 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

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

11 endpoints

Users / Access / Rights / Endpoint

Public API endpoint.

/users/access/rights/endpoint
OPTIONS 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 / 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

password, welcome_screen

Additional notes

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

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 / Linkedin

Public API endpoint.

/users/me/linkedin
PATCH 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 / Plugins

Public API endpoint.

/users/me/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.

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
POST 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
POST 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.

Zapier

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

4 endpoints

Zapier / Notifications

Public API endpoint.

/zapier/notifications
POST 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.

Zapier / Notifications / Interactions

Public API endpoint.

/zapier/notifications/interactions
POST 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.

Zapier / Pipeline

Public API endpoint.

/zapier/pipeline
POST 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.

Zapier / Pipeline / All / Leads

Public API endpoint.

/zapier/pipeline/all/leads
GET POST PATCH 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.