Reference

Reference by product domain

The reference below is generated from the same OpenAPI contract that powers the authenticated API workspace. Each operation includes scopes, parameters and request or response examples derived from the spec.

Browse referenceOpenAPI JSONCreate API key
Domains
15
Operations
65
JSON examples
Spec-derived
OpenAPI
3.1.0

How to use the reference

Start with the domain that matches your integration. For create or run operations, pair the request examples with the Quickstart guidance on idempotency, request_id and retry handling.

BillingCampaignsExportsIdentityImportsInboxJobsLead FieldsLeadsMessagesProspectorReferralsSettingsSupportWebhooks

Billing

Read subscription and usage summary data.

GET

/api/public/v1/billing/subscription

Read billing subscription summary

Read subscription and usage summary data.

billing.read200401403404409429
Parameters
Response example · BillingSubscriptionEnvelope
{
  "data": {
    "id": "string",
    "object": "billing_subscription",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "plan": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/billing/usage

Read trial and email usage

Read subscription and usage summary data.

billing.read200401403404409429
Parameters
Response example · BillingUsageEnvelope
{
  "data": {
    "id": "string",
    "object": "billing_usage",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "active_trial": false,
    "usage": {}
  },
  "request_id": "string"
}

Campaigns

Read and control outbound campaigns, runs, logs and publish flows.

GET

/api/public/v1/campaigns

List campaigns

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.read200401403404409429
Parameters
Response example · CampaignListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "campaign",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "status": "string",
      "enabled": false,
      "prospector_workflow_id": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
POST

/api/public/v1/campaigns

Create a campaign

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.write200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Request example · CampaignCreateRequest
Required body
{
  "prospector_workflow_id": "00000000-0000-0000-0000-000000000000"
}
Response example · CampaignEnvelope
{
  "data": {
    "id": "string",
    "object": "campaign",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "enabled": false,
    "prospector_workflow_id": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/campaigns/{campaign_id}

Retrieve a campaign

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.read200401403404409429
Parameters
Response example · CampaignEnvelope
{
  "data": {
    "id": "string",
    "object": "campaign",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "enabled": false,
    "prospector_workflow_id": "string"
  },
  "request_id": "string"
}
PATCH

/api/public/v1/campaigns/{campaign_id}

Update a campaign status

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.write200401403404409429
Parameters
Request example · CampaignUpdateRequest
Required body
{
  "status": "active"
}
Response example · CampaignEnvelope
{
  "data": {
    "id": "string",
    "object": "campaign",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "enabled": false,
    "prospector_workflow_id": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/campaigns/{campaign_id}/logs

List campaign logs

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.read200401403404409429
Parameters
Response example · CampaignLogListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "campaign_log",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "level": "string",
      "message": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
POST

/api/public/v1/campaigns/{campaign_id}/publish

Publish a campaign

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.publish200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Practical notes
  • Publishing is a write action and should be treated as an operational control point in external tooling.
Request example · CampaignPublishRequest
Optional body
{
  "apply_strategy": "new"
}
Response example · CampaignEnvelope
{
  "data": {
    "id": "string",
    "object": "campaign",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "enabled": false,
    "prospector_workflow_id": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/campaigns/{campaign_id}/runs

List campaign runs

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.read200401403404409429
Parameters
Response example · CampaignRunListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "campaign_run",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "status": "string",
      "campaign_id": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/campaigns/runs/{run_id}

Retrieve a campaign run

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.read200401403404409429
Parameters
Response example · CampaignRunEnvelope
{
  "data": {
    "id": "string",
    "object": "campaign_run",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "campaign_id": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/campaigns/runs/{run_id}/events

List campaign run events

Read and control outbound campaigns, runs, logs and publish flows.

campaigns.read200401403404409429
Parameters
Response example · CampaignRunEventListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "campaign_run_event",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "type": "string",
      "summary": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}

Exports

Trigger exports and poll for readiness metadata before download handling.

POST

/api/public/v1/exports

Create an export job

Trigger exports and poll for readiness metadata before download handling.

leads.export200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Request example · ExportCreateRequest
Required body
{
  "include_suppressed": false
}
Response example · ExportEnvelope
{
  "data": {
    "id": "string",
    "object": "export",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "row_count": 0,
    "file_key": "string",
    "error_message": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/exports

List export jobs

Trigger exports and poll for readiness metadata before download handling.

leads.export200401403404409429
Parameters
Response example · ExportListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "export",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "status": "string",
      "row_count": 0,
      "file_key": "string",
      "error_message": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/exports/{export_id}

Retrieve an export job

Trigger exports and poll for readiness metadata before download handling.

leads.export200401403404409429
Parameters
Response example · ExportEnvelope
{
  "data": {
    "id": "string",
    "object": "export",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "row_count": 0,
    "file_key": "string",
    "error_message": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/exports/{export_id}/download

Download a completed export

Returns download readiness metadata, not a streamed file or presigned URL. Clients should poll until `download_ready` is true and then resolve object download through the canonical product UI or worker-managed storage flow.

leads.export200401403404409429
Parameters
Practical notes
  • This route returns readiness metadata, not a streamed file or presigned URL.
  • Poll until download_ready is true, then resolve the file through the canonical product download flow.
Response example · ExportDownloadEnvelope
{
  "data": {
    "id": "string",
    "object": "export_download",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "file_key": "string",
    "download_ready": false
  },
  "request_id": "string"
}

Identity

Resolve who the key belongs to and whether the workspace is read-only.

GET

/api/public/v1/me

Retrieve API identity

Resolve who the key belongs to and whether the workspace is read-only.

me.read200401403404409429
Parameters
Response example · IdentityEnvelope
{
  "data": {
    "id": "pak_123",
    "object": "public_api_identity",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "tenant": {
      "id": "tenant_123",
      "object": "tenant",
      "name": "ProspectB2B Demo",
      "created_at": "2026-03-01T12:00:00.000Z",
      "updated_at": "2026-03-01T12:00:00.000Z"
    },
    "user": {
      "id": "user_123",
      "object": "user",
      "name": "Carlos Soccol",
      "email": "[email protected]",
      "created_at": "2026-03-01T12:00:00.000Z",
      "updated_at": "2026-03-01T12:00:00.000Z"
    },
    "role": "owner",
    "permissions": [
      "SETTINGS_EDIT",
      "LEADS_EDIT"
    ],
    "scopes": [
      "me.read",
      "leads.write"
    ],
    "read_only": false
  },
  "request_id": "string"
}

Imports

Submit bulk imports and inspect processing outcomes.

POST

/api/public/v1/imports

Create an import job

Submit bulk imports and inspect processing outcomes.

leads.import200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Request example · ImportCreateRequest
Required body
{
  "name": "string",
  "file_name": "string",
  "file_type": "string",
  "file_data": "string"
}
Response example · ImportEnvelope
{
  "data": {
    "id": "string",
    "object": "import",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "name": "string",
    "file_name": "string",
    "total_rows": 0,
    "imported_rows": 0,
    "error_count": 0
  },
  "request_id": "string"
}
GET

/api/public/v1/imports

List import jobs

Submit bulk imports and inspect processing outcomes.

leads.import200401403404409429
Parameters
Response example · ImportListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "import",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "status": "string",
      "name": "string",
      "file_name": "string",
      "total_rows": 0,
      "imported_rows": 0,
      "error_count": 0
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/imports/{import_id}

Retrieve an import job

Submit bulk imports and inspect processing outcomes.

leads.import200401403404409429
Parameters
Response example · ImportEnvelope
{
  "data": {
    "id": "string",
    "object": "import",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "name": "string",
    "file_name": "string",
    "total_rows": 0,
    "imported_rows": 0,
    "error_count": 0
  },
  "request_id": "string"
}
GET

/api/public/v1/imports/{import_id}/errors

Download import errors

Submit bulk imports and inspect processing outcomes.

leads.import200401403404409429
Parameters
Response example · ImportErrorListEnvelope
{
  "data": [
    {
      "row": 0,
      "message": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}

Inbox

Read inbox thread snapshots and thread messages.

GET

/api/public/v1/inbox/threads

List inbox threads

Read inbox thread snapshots and thread messages.

inbox.read200401403404409429
Parameters
NameInRequiredDescription
limitqueryNointeger
cursorqueryNostring
Response example · InboxThreadListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "inbox_thread",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "lead_id": "string",
      "lead_name": "string",
      "message_count": 0,
      "last_message_at": "2026-03-10T12:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/inbox/threads/{thread_id}

Retrieve an inbox thread

Read inbox thread snapshots and thread messages.

inbox.read200401403404409429
Parameters
Response example · InboxThreadEnvelope
{
  "data": {
    "id": "string",
    "object": "inbox_thread",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "lead_id": "string",
    "lead_name": "string",
    "message_count": 0,
    "last_message_at": "2026-03-10T12:00:00.000Z"
  },
  "request_id": "string"
}
GET

/api/public/v1/inbox/threads/{thread_id}/messages

List inbox thread messages

Read inbox thread snapshots and thread messages.

inbox.read200401403404409429
Parameters
Response example · InboxMessageListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "message",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "direction": "string",
      "channel": "string",
      "subject": "string",
      "body": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}

Jobs

Inspect long-running async jobs and their event history.

GET

/api/public/v1/jobs

List async jobs

Inspect long-running async jobs and their event history.

jobs.read200401403404409429
Parameters
Response example · AsyncJobListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "job",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "type": "string",
      "status": "string",
      "started_at": "2026-03-10T12:00:00.000Z",
      "finished_at": "2026-03-10T12:00:00.000Z",
      "progress": 0,
      "result": {},
      "error": {}
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/jobs/{job_id}

Retrieve an async job

Inspect long-running async jobs and their event history.

jobs.read200401403404409429
Parameters
Response example · AsyncJobEnvelope
{
  "data": {
    "id": "string",
    "object": "job",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "type": "string",
    "status": "string",
    "started_at": "2026-03-10T12:00:00.000Z",
    "finished_at": "2026-03-10T12:00:00.000Z",
    "progress": 0,
    "result": {},
    "error": {}
  },
  "request_id": "string"
}
GET

/api/public/v1/jobs/{job_id}/events

List job events

Inspect long-running async jobs and their event history.

jobs.read200401403404409429
Parameters
Response example · JobEventListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "job_event",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "level": "string",
      "message": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}

Lead Fields

Inspect custom lead fields before importing or patching mapped values.

GET

/api/public/v1/lead-fields

List lead fields

Inspect custom lead fields before importing or patching mapped values.

lead-fields.read200401403404409429
Parameters
Response example · LeadFieldListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "lead_field",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "key": "string",
      "label": "string",
      "field_type": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/lead-fields/{field_id}

Retrieve a lead field

Inspect custom lead fields before importing or patching mapped values.

lead-fields.read200401403404409429
Parameters
Response example · LeadFieldEnvelope
{
  "data": {
    "id": "string",
    "object": "lead_field",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "key": "string",
    "label": "string",
    "field_type": "string"
  },
  "request_id": "string"
}

Leads

Create, sync and incrementally read lead records plus related activity.

GET

/api/public/v1/leads

List leads

Create, sync and incrementally read lead records plus related activity.

leads.read200401403404409429
Parameters
NameInRequiredDescription
limitqueryNointeger
cursorqueryNostring
created_afterqueryNostring
created_beforequeryNostring
updated_afterqueryNostring
updated_beforequeryNostring
Practical notes
  • Use updated_after and cursor pagination to keep downstream CRMs synchronized incrementally.
Response example · LeadListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "lead",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "full_name": "string",
      "email": "[email protected]",
      "phone": "string",
      "company_name": "string",
      "title": "string",
      "location": "string",
      "tags": [
        "string"
      ],
      "is_qualified": false
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
POST

/api/public/v1/leads

Create a lead

Create, sync and incrementally read lead records plus related activity.

leads.write200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Practical notes
  • Send Idempotency-Key on create requests so retries stay safe across network failures.
  • For incremental syncs, pair list filtering with updated_after on the list endpoint.
Request example · LeadCreateRequest
Required body
{
  "full_name": "Ada Lovelace",
  "email": "[email protected]",
  "phone": "+15555550123",
  "company_name": "Analytical Engine Inc.",
  "column_id": "00000000-0000-0000-0000-000000000000",
  "notes": "string"
}
Response example · LeadEnvelope
{
  "data": {
    "id": "string",
    "object": "lead",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "full_name": "string",
    "email": "[email protected]",
    "phone": "string",
    "company_name": "string",
    "title": "string",
    "location": "string",
    "tags": [
      "string"
    ],
    "is_qualified": false
  },
  "request_id": "string"
}
GET

/api/public/v1/leads/{lead_id}

Retrieve a lead

Create, sync and incrementally read lead records plus related activity.

leads.read200401403404409429
Parameters
Response example · LeadEnvelope
{
  "data": {
    "id": "string",
    "object": "lead",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "full_name": "string",
    "email": "[email protected]",
    "phone": "string",
    "company_name": "string",
    "title": "string",
    "location": "string",
    "tags": [
      "string"
    ],
    "is_qualified": false
  },
  "request_id": "string"
}
PATCH

/api/public/v1/leads/{lead_id}

Update a lead

Create, sync and incrementally read lead records plus related activity.

leads.write200401403404409429
Parameters
Request example · LeadUpsertRequest
Required body
{
  "full_name": "Ada Lovelace",
  "email": "[email protected]",
  "phone": "+15555550123",
  "company_name": "Analytical Engine Inc.",
  "column_id": "00000000-0000-0000-0000-000000000000",
  "notes": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "string",
  "location": "string",
  "tags": [
    "string"
  ],
  "owner_user_id": "00000000-0000-0000-0000-000000000000",
  "value_amount": 0,
  "due_date": "2026-03-10T12:00:00.000Z",
  "is_qualified": false
}
Response example · LeadEnvelope
{
  "data": {
    "id": "string",
    "object": "lead",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "full_name": "string",
    "email": "[email protected]",
    "phone": "string",
    "company_name": "string",
    "title": "string",
    "location": "string",
    "tags": [
      "string"
    ],
    "is_qualified": false
  },
  "request_id": "string"
}
GET

/api/public/v1/leads/{lead_id}/activities

List lead activities

Create, sync and incrementally read lead records plus related activity.

leads.read200401403404409429
Parameters
NameInRequiredDescription
limitqueryNointeger
cursorqueryNostring
Response example · LeadActivityListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "lead_activity",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "type": "string",
      "summary": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
POST

/api/public/v1/leads/bulk

Create or upsert multiple leads

Create, sync and incrementally read lead records plus related activity.

leads.write200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Request example · LeadBulkRequest
Required body
{
  "leads": [
    {
      "full_name": "Ada Lovelace",
      "email": "[email protected]",
      "phone": "+15555550123",
      "company_name": "Analytical Engine Inc.",
      "column_id": "00000000-0000-0000-0000-000000000000",
      "notes": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "location": "string",
      "tags": [
        "string"
      ],
      "owner_user_id": "00000000-0000-0000-0000-000000000000",
      "value_amount": 0,
      "due_date": "2026-03-10T12:00:00.000Z",
      "is_qualified": false
    }
  ]
}
Response example · LeadListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "lead",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "full_name": "string",
      "email": "[email protected]",
      "phone": "string",
      "company_name": "string",
      "title": "string",
      "location": "string",
      "tags": [
        "string"
      ],
      "is_qualified": false
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
POST

/api/public/v1/leads/upsert

Upsert a lead by email or phone

Create, sync and incrementally read lead records plus related activity.

leads.write200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Request example · LeadUpsertRequest
Required body
{
  "full_name": "Ada Lovelace",
  "email": "[email protected]",
  "phone": "+15555550123",
  "company_name": "Analytical Engine Inc.",
  "column_id": "00000000-0000-0000-0000-000000000000",
  "notes": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "title": "string",
  "location": "string",
  "tags": [
    "string"
  ],
  "owner_user_id": "00000000-0000-0000-0000-000000000000",
  "value_amount": 0,
  "due_date": "2026-03-10T12:00:00.000Z",
  "is_qualified": false
}
Response example · LeadEnvelope
{
  "data": {
    "id": "string",
    "object": "lead",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "full_name": "string",
    "email": "[email protected]",
    "phone": "string",
    "company_name": "string",
    "title": "string",
    "location": "string",
    "tags": [
      "string"
    ],
    "is_qualified": false
  },
  "request_id": "string"
}

Messages

Read lead-centric message history for CRM or support syncs.

GET

/api/public/v1/leads/{lead_id}/messages

List lead messages

Read lead-centric message history for CRM or support syncs.

messages.read200401403404409429
Parameters
Response example · LeadMessageListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "message",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "direction": "string",
      "channel": "string",
      "subject": "string",
      "body": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}

Prospector

Read and run prospecting workflows aligned to the existing workspace model.

GET

/api/public/v1/prospector/config

Read prospector config

Read and run prospecting workflows aligned to the existing workspace model.

prospector.read200401403404409429
Parameters
Response example · ProspectorConfigEnvelope
{
  "data": {
    "id": "string",
    "object": "prospector_config",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "timezone": "string",
    "states": [
      {}
    ]
  },
  "request_id": "string"
}
GET

/api/public/v1/prospector/runs/{run_id}

Retrieve a prospector run

Read and run prospecting workflows aligned to the existing workspace model.

prospector.read200401403404409429
Parameters
Response example · ProspectorRunEnvelope
{
  "data": {
    "id": "string",
    "object": "prospector_run",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "workflow_id": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/prospector/runs/{run_id}/results

List prospector run results

Read and run prospecting workflows aligned to the existing workspace model.

prospector.read200401403404409429
Parameters
Response example · ProspectorResultListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "prospector_result",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "lead_id": "string",
      "company_name": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/prospector/workflows

List prospector workflows

Read and run prospecting workflows aligned to the existing workspace model.

prospector.read200401403404409429
Parameters
Response example · ProspectorWorkflowListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "prospector_workflow",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "name": "string",
      "status": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
POST

/api/public/v1/prospector/workflows

Create a prospector workflow

Read and run prospecting workflows aligned to the existing workspace model.

prospector.run200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Request example · ProspectorWorkflowRequest
Required body
{}
Response example · ProspectorWorkflowEnvelope
{
  "data": {
    "id": "string",
    "object": "prospector_workflow",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "name": "string",
    "status": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/prospector/workflows/{workflow_id}

Retrieve a prospector workflow

Read and run prospecting workflows aligned to the existing workspace model.

prospector.read200401403404409429
Parameters
Response example · ProspectorWorkflowEnvelope
{
  "data": {
    "id": "string",
    "object": "prospector_workflow",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "name": "string",
    "status": "string"
  },
  "request_id": "string"
}
PATCH

/api/public/v1/prospector/workflows/{workflow_id}

Update a prospector workflow

Read and run prospecting workflows aligned to the existing workspace model.

prospector.run200401403404409429
Parameters
Request example · ProspectorWorkflowRequest
Required body
{}
Response example · ProspectorWorkflowEnvelope
{
  "data": {
    "id": "string",
    "object": "prospector_workflow",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "name": "string",
    "status": "string"
  },
  "request_id": "string"
}
DELETE

/api/public/v1/prospector/workflows/{workflow_id}

Delete a prospector workflow

Read and run prospecting workflows aligned to the existing workspace model.

prospector.run200401403404409429
Parameters
Response example · ProspectorWorkflowEnvelope
{
  "data": {
    "id": "string",
    "object": "prospector_workflow",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "name": "string",
    "status": "string"
  },
  "request_id": "string"
}
POST

/api/public/v1/prospector/workflows/{workflow_id}/run

Run a prospector workflow immediately

Read and run prospecting workflows aligned to the existing workspace model.

prospector.run200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Practical notes
  • Use idempotency and track request_id when manually triggering workflows from automation.
Response example · ProspectorRunEnvelope
{
  "data": {
    "id": "string",
    "object": "prospector_run",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string",
    "workflow_id": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/prospector/workflows/{workflow_id}/runs

List prospector runs

Read and run prospecting workflows aligned to the existing workspace model.

prospector.read200401403404409429
Parameters
Response example · ProspectorRunListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "prospector_run",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "status": "string",
      "workflow_id": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}

Referrals

Read referral activity and summary metrics.

GET

/api/public/v1/referrals

List referral activity

Read referral activity and summary metrics.

referrals.read200401403404409429
Parameters
Response example · ReferralListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "referral",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "email": "[email protected]",
      "status": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/referrals/summary

Read referral summary

Read referral activity and summary metrics.

referrals.read200401403404409429
Parameters
Response example · ReferralSummaryEnvelope
{
  "data": {
    "id": "string",
    "object": "referral_summary",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "total_referrals": 0,
    "qualified_referrals": 0
  },
  "request_id": "string"
}

Settings

Read profile, messaging and integration snapshots for workspace sync.

GET

/api/public/v1/settings/email

Read email settings

Read profile, messaging and integration snapshots for workspace sync.

settings.read200401403404409429
Parameters
Response example · SettingsEmailEnvelope
{
  "data": {
    "id": "string",
    "object": "settings_email",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "verified_senders": [
      {}
    ]
  },
  "request_id": "string"
}
GET

/api/public/v1/settings/integrations

Read integrations settings

Read profile, messaging and integration snapshots for workspace sync.

settings.read200401403404409429
Parameters
Response example · SettingsIntegrationsEnvelope
{
  "data": {
    "id": "string",
    "object": "settings_integrations",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "integrations": [
      {}
    ]
  },
  "request_id": "string"
}
GET

/api/public/v1/settings/lead-qualification

Read lead qualification settings

Read profile, messaging and integration snapshots for workspace sync.

settings.read200401403404409429
Parameters
Response example · SettingsLeadQualificationEnvelope
{
  "data": {
    "id": "string",
    "object": "settings_lead_qualification",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "mode_preset": "string",
    "enabled_signals": {}
  },
  "request_id": "string"
}
GET

/api/public/v1/settings/profile

Read profile settings

Read profile, messaging and integration snapshots for workspace sync.

settings.read200401403404409429
Parameters
Response example · SettingsProfileEnvelope
{
  "data": {
    "id": "string",
    "object": "settings_profile",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "name": "string",
    "email": "[email protected]"
  },
  "request_id": "string"
}
GET

/api/public/v1/settings/sms

Read SMS settings

Read profile, messaging and integration snapshots for workspace sync.

settings.read200401403404409429
Parameters
Response example · SettingsSmsEnvelope
{
  "data": {
    "id": "string",
    "object": "settings_sms",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/settings/voice

Read voice settings

Read profile, messaging and integration snapshots for workspace sync.

settings.read200401403404409429
Parameters
Response example · SettingsVoiceEnvelope
{
  "data": {
    "id": "string",
    "object": "settings_voice",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "status": "string"
  },
  "request_id": "string"
}

Support

Create and track support tickets from external systems.

GET

/api/public/v1/support/tickets

List support tickets

Create and track support tickets from external systems.

support.read200401403404409429
Parameters
Response example · SupportTicketListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "support_ticket",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "subject": "string",
      "body": "string",
      "status": "string",
      "source": "string"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
POST

/api/public/v1/support/tickets

Create a support ticket

Create and track support tickets from external systems.

support.write200401403404409429
Parameters
Request example · SupportTicketCreateRequest
Required body
{
  "subject": "string",
  "body": "string"
}
Response example · SupportTicketEnvelope
{
  "data": {
    "id": "string",
    "object": "support_ticket",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "subject": "string",
    "body": "string",
    "status": "string",
    "source": "string"
  },
  "request_id": "string"
}
GET

/api/public/v1/support/tickets/{ticket_id}

Retrieve a support ticket

Create and track support tickets from external systems.

support.read200401403404409429
Parameters
Response example · SupportTicketEnvelope
{
  "data": {
    "id": "string",
    "object": "support_ticket",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "subject": "string",
    "body": "string",
    "status": "string",
    "source": "string"
  },
  "request_id": "string"
}

Webhooks

Register signed webhook sinks, inspect deliveries and retry failures safely.

GET

/api/public/v1/webhooks

List webhook endpoints

Register signed webhook sinks, inspect deliveries and retry failures safely.

webhooks.read200401403404409429
Parameters
Response example · WebhookListEnvelope
{
  "data": [
    {
      "id": "whe_123",
      "object": "public_api_webhook_endpoint",
      "url": "https://example.com/webhooks/prospectb2b",
      "description": "Primary sink",
      "events": [
        "lead.created",
        "export.completed"
      ],
      "signing_secret_prefix": "whsec_demo",
      "last_delivered_at": null,
      "disabled_at": null,
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
POST

/api/public/v1/webhooks

Create a webhook endpoint

Register signed webhook sinks, inspect deliveries and retry failures safely.

webhooks.write200401403404409429
Parameters
NameInRequiredDescription
Idempotency-KeyheaderNoRequired for safe retries on create, upsert, bulk, import, export, campaign and prospector mutations.
Practical notes
  • Persist the signing secret immediately. The secret is shown once at creation time.
  • Subscribe only to the events your workflow processes to keep retries and observability clean.
Request example · WebhookCreateRequest
Required body
{
  "url": "string",
  "description": "string",
  "events": [
    "string"
  ]
}
Response example · WebhookEnvelope
{
  "data": {
    "id": "whe_123",
    "object": "public_api_webhook_endpoint",
    "url": "https://example.com/webhooks/prospectb2b",
    "description": "Primary sink",
    "events": [
      "lead.created",
      "export.completed"
    ],
    "signing_secret_prefix": "whsec_demo",
    "last_delivered_at": null,
    "disabled_at": null,
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z"
  },
  "request_id": "string"
}
GET

/api/public/v1/webhooks/{webhook_id}

Retrieve a webhook endpoint

Register signed webhook sinks, inspect deliveries and retry failures safely.

webhooks.read200401403404409429
Parameters
Response example · WebhookEnvelope
{
  "data": {
    "id": "whe_123",
    "object": "public_api_webhook_endpoint",
    "url": "https://example.com/webhooks/prospectb2b",
    "description": "Primary sink",
    "events": [
      "lead.created",
      "export.completed"
    ],
    "signing_secret_prefix": "whsec_demo",
    "last_delivered_at": null,
    "disabled_at": null,
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z"
  },
  "request_id": "string"
}
PATCH

/api/public/v1/webhooks/{webhook_id}

Update a webhook endpoint

Register signed webhook sinks, inspect deliveries and retry failures safely.

webhooks.write200401403404409429
Parameters
Request example · WebhookCreateRequest
Required body
{
  "url": "string",
  "description": "string",
  "events": [
    "string"
  ]
}
Response example · WebhookEnvelope
{
  "data": {
    "id": "whe_123",
    "object": "public_api_webhook_endpoint",
    "url": "https://example.com/webhooks/prospectb2b",
    "description": "Primary sink",
    "events": [
      "lead.created",
      "export.completed"
    ],
    "signing_secret_prefix": "whsec_demo",
    "last_delivered_at": null,
    "disabled_at": null,
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z"
  },
  "request_id": "string"
}
DELETE

/api/public/v1/webhooks/{webhook_id}

Delete a webhook endpoint

Register signed webhook sinks, inspect deliveries and retry failures safely.

webhooks.write200401403404409429
Parameters
Response example · WebhookEnvelope
{
  "data": {
    "id": "whe_123",
    "object": "public_api_webhook_endpoint",
    "url": "https://example.com/webhooks/prospectb2b",
    "description": "Primary sink",
    "events": [
      "lead.created",
      "export.completed"
    ],
    "signing_secret_prefix": "whsec_demo",
    "last_delivered_at": null,
    "disabled_at": null,
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z"
  },
  "request_id": "string"
}
GET

/api/public/v1/webhooks/{webhook_id}/deliveries

List webhook deliveries

Register signed webhook sinks, inspect deliveries and retry failures safely.

webhooks.read200401403404409429
Parameters
Response example · WebhookDeliveryListEnvelope
{
  "data": [
    {
      "id": "string",
      "object": "public_api_webhook_delivery",
      "created_at": "2026-03-10T12:00:00.000Z",
      "updated_at": "2026-03-10T12:00:00.000Z",
      "event": "string",
      "status": "queued",
      "payload_redacted": {},
      "request_headers": {},
      "response_status_code": 0,
      "response_headers": {},
      "response_body_snippet": "string",
      "error_message": "string",
      "attempt_count": 0,
      "delivered_at": "2026-03-10T12:00:00.000Z",
      "last_attempted_at": "2026-03-10T12:00:00.000Z",
      "next_attempt_at": "2026-03-10T12:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "lead_002",
    "has_more": true
  },
  "request_id": "string"
}
GET

/api/public/v1/webhooks/{webhook_id}/deliveries/{delivery_id}

Retrieve a webhook delivery

Register signed webhook sinks, inspect deliveries and retry failures safely.

webhooks.read200401403404409429
Parameters
Response example · WebhookDeliveryEnvelope
{
  "data": {
    "id": "string",
    "object": "public_api_webhook_delivery",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "event": "string",
    "status": "queued",
    "payload_redacted": {},
    "request_headers": {},
    "response_status_code": 0,
    "response_headers": {},
    "response_body_snippet": "string",
    "error_message": "string",
    "attempt_count": 0,
    "delivered_at": "2026-03-10T12:00:00.000Z",
    "last_attempted_at": "2026-03-10T12:00:00.000Z",
    "next_attempt_at": "2026-03-10T12:00:00.000Z"
  },
  "request_id": "string"
}
POST

/api/public/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/retry

Retry a webhook delivery

Register signed webhook sinks, inspect deliveries and retry failures safely.

webhooks.write200401403404409429
Parameters
Practical notes
  • Retry only after your endpoint is fixed. The delivery history keeps the original payload and attempts.
Response example · WebhookDeliveryEnvelope
{
  "data": {
    "id": "string",
    "object": "public_api_webhook_delivery",
    "created_at": "2026-03-10T12:00:00.000Z",
    "updated_at": "2026-03-10T12:00:00.000Z",
    "event": "string",
    "status": "queued",
    "payload_redacted": {},
    "request_headers": {},
    "response_status_code": 0,
    "response_headers": {},
    "response_body_snippet": "string",
    "error_message": "string",
    "attempt_count": 0,
    "delivered_at": "2026-03-10T12:00:00.000Z",
    "last_attempted_at": "2026-03-10T12:00:00.000Z",
    "next_attempt_at": "2026-03-10T12:00:00.000Z"
  },
  "request_id": "string"
}