TermsPrivacyAcceptable useData sourcesRemoval request
LeadIntelQuickstartAPI referenceScopesErrorsopenapi.json

API reference

LeadIntel API 1.0.0, rendered from the committed OpenAPI contract (/v1/openapi.json). New here? Start with the quickstart. Session-cookie clients also send X-Tenant-Id and, on writes, X-CSRF-Token; API keys send Authorization: Bearer only. Verbs follow /resource/{id}:verb; older /verb paths are deprecated and answer with Deprecation and Sunset headers.

adminapi-keysbillingcatalogcomplianceenrichmentsexportsidentityinsightsjobsmetaorganizationspartnersalessearchestenancyusagewatchlistwebhooks

admin

GET/v1/admin/tenantsList Tenants

List Tenants for the authenticated tenant.

Scopes: platform_admin

Parameters

  • status (query, "active" | "suspended" | "deleting" | null)
  • plan_key (query, string | null)
  • q (query, string | null)
  • limit (query, integer)
  • cursor (query, string | null)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
POST/v1/admin/tenantsProvision Tenant

Provision Tenant for the authenticated tenant.

Scopes: platform_admin

Parameters

  • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

Request body ProvisionTenantBody

  • name (string, required)
  • plan_key (string)
  • scopes (string[])

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
  • 409 RFC 9457 problem response.
POST/v1/admin/deletion-requestsCreate Deletion Request

Purge a public-source subject from global intelligence and suppress re-ingest.

Scopes: platform_admin

Parameters

  • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

Request body DeletionRequestBody

  • subject_type ("organization" | "contact" | "person", required)
  • subject (string, required)
  • person_ids (string[])

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
  • 409 RFC 9457 problem response.
GET/v1/admin/merge-candidatesGet Merge Candidates

Get Merge Candidates for the authenticated tenant.

Scopes: platform_admin

Parameters

  • status (query, string)
  • limit (query, integer)
  • cursor (query, string | null)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
POST/v1/admin/merge-candidates/{candidate_id}/decidedeprecatedPost Merge Candidate Decision

Post Merge Candidate Decision for the authenticated tenant.

Scopes: platform_admin

Parameters

  • candidate_id (path, string, required)

Request body MergeDecision

  • decision (string, required)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 404 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
  • 409 RFC 9457 problem response.
POST/v1/admin/merge-candidates/{candidate_id}:decidePost Merge Candidate Decision

Post Merge Candidate Decision for the authenticated tenant.

Scopes: platform_admin

Parameters

  • candidate_id (path, string, required)

Request body MergeDecision

  • decision (string, required)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 404 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
  • 409 RFC 9457 problem response.
GET/v1/admin/outboxOutbox Health

Outbox Health for the authenticated tenant.

Scopes: platform_admin

Responses

  • 200 Successful Response
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
GET/v1/admin/webhook-deliveriesList Webhook Deliveries

List Webhook Deliveries for the authenticated tenant.

Scopes: platform_admin

Parameters

  • status (query, "pending" | "delivering" | "delivered" | "failed" | null)
  • tenant_id (query, string | null)
  • limit (query, integer)
  • cursor (query, string | null)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
GET/v1/admin/tenants/{tenant_id}Get Tenant

Get Tenant for the authenticated tenant.

Scopes: platform_admin

Parameters

  • tenant_id (path, string, required)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 404 RFC 9457 problem response.
PATCH/v1/admin/tenants/{tenant_id}Patch Tenant

Patch Tenant for the authenticated tenant.

Scopes: platform_admin

Parameters

  • tenant_id (path, string, required)

Request body TenantPatch

  • plan_key (string | null)
  • status ("active" | "suspended" | null)
  • monthly_credits_override (integer | null)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 404 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
  • 409 RFC 9457 problem response.
POST/v1/admin/tenants/{tenant_id}/creditsAdjust Tenant Credits

Adjust Tenant Credits for the authenticated tenant.

Scopes: platform_admin

Parameters

  • tenant_id (path, string, required)
  • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

Request body CreditAdjustment

  • amount (integer, required)
  • kind ("grant" | "adjust", required)
  • direction ("credit" | "debit" | null)
  • reason (string, required)
  • force (boolean)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 404 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
  • 409 RFC 9457 problem response.
GET/v1/admin/tenants/{tenant_id}/pricesGet Tenant Prices

Get Tenant Prices for the authenticated tenant.

Scopes: platform_admin

Parameters

  • tenant_id (path, string, required)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 404 RFC 9457 problem response.
PUT/v1/admin/tenants/{tenant_id}/pricesPut Tenant Prices

Replace the tenant's whole override set; an empty map restores platform defaults.

Scopes: platform_admin

Parameters

  • tenant_id (path, string, required)

Request body PriceOverrides

  • prices (object, required)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 404 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
  • 409 RFC 9457 problem response.
GET/v1/admin/removal-requestsList Removal Requests

List Removal Requests for the authenticated tenant.

Scopes: platform_admin

Parameters

  • status (query, "pending" | "completed" | "rejected")
  • limit (query, integer)
  • cursor (query, string | null)

Responses

  • 200 Successful Response
  • 422 Validation Error
  • 401 RFC 9457 problem response.
  • 500 RFC 9457 problem response.
  • 403 RFC 9457 problem response.
  • 400 RFC 9457 problem response.
POST/v1/admin/removal-requests/{request_id}/approveApprove Removal Request

Run the global purge for a public request; a repeat approval changes nothing.

Scopes: platform_admin

Parameters

  • request_id (path, string, required)

Request body ApproveRemovalBody | null

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/admin/removal-requests/{request_id}/rejectReject Removal Request

    Reject Removal Request for the authenticated tenant.

    Scopes: platform_admin

    Parameters

    • request_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    api-keys

    GET/v1/api-keysList Api Keys

    List Api Keys for the authenticated tenant.

    Scopes: apikey:manage

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/api-keysCreate Api Key

    Create Api Key for the authenticated tenant.

    Scopes: apikey:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body ApiKeyBody

    • name (string, required)
    • scopes (string[], required)
    • expires_at (string | null)
    • rate_limit_override (integer | null)
    • mode ("live" | "test" | null)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/api-keys/{key_id}Get Api Key

    Key metadata only: the secret and its hash are never returned.

    Scopes: apikey:manage

    Parameters

    • key_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    DELETE/v1/api-keys/{key_id}Revoke Api Key

    Revoke Api Key for the authenticated tenant.

    Scopes: apikey:manage

    Parameters

    • key_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/api-keys/{key_id}/rotatedeprecatedRotate Api Key

    Rotate Api Key for the authenticated tenant.

    Scopes: apikey:manage

    Parameters

    • key_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/api-keys/{key_id}:rotateRotate Api Key

    Rotate Api Key for the authenticated tenant.

    Scopes: apikey:manage

    Parameters

    • key_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    billing

    POST/v1/billing/checkoutCreate Checkout

    Open a provider checkout for a plan or a one-off credit pack.

    Scopes: billing:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body CheckoutBody

    • plan_key (string | null)
    • pack_key (string | null)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/billing/catalogBilling Catalog

    Plans and active credit packs with prices in minor units; reads need no billing role.

    Scopes: usage:read

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    GET/v1/billing/portalBilling Portal

    Hosted portal link when the provider has one, plus the workspace's recent payments.

    Scopes: billing:manage

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    POST/v1/billing/webhooks/{provider}Billing Webhook

    Provider callback: signature-verified, idempotent on the provider event id.

    Scopes: any valid credential

    Parameters

    • provider (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    catalog

    GET/v1/productsGet Products

    Get Products for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/productsPost Product

    Post Product for the authenticated tenant.

    Scopes: product:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body ProductBody

    • name (string, required)
    • slug (string, required)
    • description (string)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/products/{product_id}Get Product

    Get Product for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • product_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/products/{product_id}Patch Product

    Patch Product for the authenticated tenant.

    Scopes: product:manage

    Parameters

    • product_id (path, string, required)

    Request body ProductBody

    • name (string, required)
    • slug (string, required)
    • description (string)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/products/{product_id}Delete Product

    Delete Product for the authenticated tenant.

    Scopes: product:manage

    Parameters

    • product_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/icpsGet Icps

    Get Icps for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/icpsPost Icp

    Post Icp for the authenticated tenant.

    Scopes: product:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body IcpBody

    • product_id (string, required)
    • name (string, required)
    • industries (string[])
    • geography (object)
    • size (object)
    • weights (object)
    • thresholds (object)
    • rules (RuleBody[])

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/icps/{icp_id}Get Icp

    Get Icp for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • icp_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/icps/{icp_id}Patch Icp

    Patch Icp for the authenticated tenant.

    Scopes: product:manage

    Parameters

    • icp_id (path, string, required)

    Request body IcpBody

    • product_id (string, required)
    • name (string, required)
    • industries (string[])
    • geography (object)
    • size (object)
    • weights (object)
    • thresholds (object)
    • rules (RuleBody[])

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/icps/{icp_id}Delete Icp

    Delete Icp for the authenticated tenant.

    Scopes: product:manage

    Parameters

    • icp_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/products/templates:installInstall Templates

    Install Templates for the authenticated tenant.

    Scopes: product:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    compliance

    POST/v1/removal-requestsCreate Removal Request

    Public, unauthenticated removal request: queued for admin approval, deletes nothing. The response is identical whether or not we hold data for the value, so the form cannot be used to probe what the platform knows.

    Scopes: any valid credential

    Parameters

    • Idempotency-Key (header, string | null)

    Request body RemovalRequestBody

    • subject_type ("organization" | "contact" | "person", required)
    • value (string, required)
    • requester_email (string, required)
    • note (string)

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    enrichments

    GET/v1/enrichmentsList Enrichments

    List Enrichments for the authenticated tenant.

    Scopes: enrichment:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/enrichmentsCreate Enrichment

    Create Enrichment for the authenticated tenant.

    Scopes: lead:enrich

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body EnrichmentBody

    • domains (string[])
    • organization_ids (string[])
    • depth (string)
    • callback (Callback | null)

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/enrichments/{enrichment_id}Get Enrichment

    Get Enrichment for the authenticated tenant.

    Scopes: enrichment:read

    Parameters

    • enrichment_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.

    exports

    GET/v1/exportsList Exports

    List Exports for the authenticated tenant.

    Scopes: export:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/exportsCreate Export

    Create Export for the authenticated tenant.

    Scopes: export:create

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body ExportBody

    • format (string)
    • list_id (string | null)
    • search_id (string | null)
    • callback (Callback | null)

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/exports/{export_id}Get Export

    Get Export for the authenticated tenant.

    Scopes: export:read

    Parameters

    • export_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    GET/v1/exports/{export_id}/downloadDownload Export

    Stream a completed export through the API so clients never need the storage host.

    Scopes: export:read

    Parameters

    • export_id (path, string, required)

    Responses

    • 200 The export file, streamed from object storage.
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.

    identity

    POST/v1/auth/signupSignup

    Signup for the authenticated tenant.

    Scopes: any valid credential

    Request body SignupBody

    • email (string, required)
    • password (string, required)
    • display_name (string, required)
    • tenant_name (string | null)
    • accept_terms (boolean, required)
    • invitation_token (string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/auth/loginLogin

    Login for the authenticated tenant.

    Scopes: any valid credential

    Request body LoginBody

    • email (string, required)
    • password (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/auth/logoutLogout

    Logout for the authenticated tenant.

    Scopes: any valid credential

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/meMe

    Me for the authenticated tenant.

    Scopes: any valid credential

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    POST/v1/auth/password-reset:requestPassword Reset Request

    Always answers 202 so the response never reveals whether an account exists.

    Scopes: any valid credential

    Request body PasswordResetRequestBody

    • email (string, required)

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/auth/password-reset:confirmPassword Reset Confirm

    Password Reset Confirm for the authenticated tenant.

    Scopes: any valid credential

    Request body PasswordResetConfirmBody

    • token (string, required)
    • new_password (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/auth/verify-emailVerify Email

    Verify Email for the authenticated tenant.

    Scopes: any valid credential

    Request body VerifyEmailBody

    • token (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/auth/verify-email:resendResend Verification

    Resend Verification for the authenticated tenant.

    Scopes: any valid credential

    Responses

    • 202 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/auth/sessionsList Sessions

    List Sessions for the authenticated tenant.

    Scopes: any valid credential

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    DELETE/v1/auth/sessions/{session_id}Revoke Session

    Revoke Session for the authenticated tenant.

    Scopes: any valid credential

    Parameters

    • session_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/auth/sessions:revoke-othersRevoke Other Sessions

    Revoke Other Sessions for the authenticated tenant.

    Scopes: any valid credential

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    insights

    GET/v1/organizations/{org_id}/insightsGet Organization Insights

    Get Organization Insights for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • org_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    POST/v1/leads/{lead_id}/insights:generateGenerate Lead Insights

    Generate Lead Insights for the authenticated tenant.

    Scopes: lead:enrich

    Parameters

    • lead_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.

    jobs

    POST/v1/uploadsCreate Upload

    Register one file (CSV or JSONL); send its bytes with `PUT` to the returned `url`.

    Scopes: job:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body UploadBody

    • content_type ("text/csv" | "application/x-ndjson", required)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    PUT/v1/uploads/{upload_id}Put Upload

    Stream the file into storage with the declared content type; over the size cap is 413. Re-sending replaces the file until a job takes the upload (then 409).

    Scopes: job:manage

    Parameters

    • upload_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/organizations:matchJobsCreate Match Job

    Match every row of an uploaded file; billed per newly revealed organization, like `organizations:match`. Rows are numbered from 1 (the CSV header is not a row).

    Scopes: lead:lookup

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body MatchJobBody

    • upload_id (string, required)
    • format ("csv" | "jsonl")
    • columns (object) Field name to the column (CSV header or JSONL key) that holds it. Unmapped fields default to a same-named column.
    • callback (Callback | null)

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    POST/v1/enrichments:bulkCreate Enrichment Job

    Enrich every domain of an uploaded file; credits are reserved per chunk of rows.

    Scopes: lead:enrich

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body EnrichJobBody

    • upload_id (string, required)
    • format ("csv" | "jsonl")
    • columns (object) Field name to the column (CSV header or JSONL key) that holds it. Unmapped fields default to a same-named column.
    • callback (Callback | null)
    • depth ("basic" | "standard" | "deep")

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/jobs/{job_id}Get Job

    Get Job for the authenticated tenant.

    Scopes: job:read

    Parameters

    • job_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    GET/v1/jobs/{job_id}/downloadDownload Job Result

    Rows that were processed successfully, ordered by input row number.

    Scopes: job:read

    Parameters

    • job_id (path, string, required)

    Responses

    • 200 The CSV file, streamed from object storage.
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    GET/v1/jobs/{job_id}/errorsDownload Job Errors

    Rows that could not be processed: `row, ref, error_code, detail`.

    Scopes: job:read

    Parameters

    • job_id (path, string, required)

    Responses

    • 200 The CSV file, streamed from object storage.
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    POST/v1/jobs/{job_id}:cancelCancel Job

    Stop a queued or running job after its current chunk; processed rows stay billed and their results are published.

    Scopes: job:manage

    Parameters

    • job_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    meta

    GET/v1/scopesScopes

    Catalog of every scope and the roles that hold it; `platform` scopes are never role-held.

    Scopes: any valid credential

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    GET/v1/whoamiWhoami

    The calling credential: key id and scopes, or the session user, plus the tenant.

    Scopes: any valid credential

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    GET/v1/limitsLimits

    Plan and credit limits as enforced today; nothing here is a new enforcement.

    Scopes: usage:read

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    POST/v1/searches:estimateEstimate Search

    Credits a search would reserve, priced by the same events the workflow reserves with.

    Scopes: search:create

    Request body SearchDefinition

    • query (string, required)
    • industry (string | null)
    • location (Location, required)
    • max_results (integer, required)
    • company_size (string | null)
    • must_have (string[])
    • prefer (string[])
    • exclude (string[])
    • sources (string[])
    • depth (string)
    • product_id (string | null)
    • icp_id (string | null)
    • campaign_id (string | null)
    • webhook_endpoint_id (string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/enrichments:estimateEstimate Enrichment

    Credits an enrichment would reserve: the website price per domain, as the workflow does.

    Scopes: lead:enrich

    Request body EnrichmentEstimateBody

    • domains (string[])
    • organization_ids (string[])

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    organizations

    GET/v1/organizationsOrganizations Search

    Search only organizations this tenant can already see (no credits).

    Scopes: lead:read

    Parameters

    • q (query, string | null)
    • industry (query, string | null)
    • country (query, string | null)
    • city (query, string | null)
    • has (query, string[] | null)
    • min_rating (query, number | null)
    • sort (query, string)
    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    GET/v1/organizations/facetsOrganization Facets

    Organization Facets for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • q (query, string | null)
    • industry (query, string | null)
    • country (query, string | null)
    • city (query, string | null)
    • has (query, string[] | null)
    • min_rating (query, number | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    POST/v1/organizations:batchGetOrganizations Batch Get

    Return visible organizations; unknown and invisible ids are indistinguishable.

    Scopes: lead:read

    Request body BatchGetBody

    • ids (string[], required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/organizations:lookupOrganization Lookup

    Resolve one business synchronously. The first reveal costs one `lookup` credit.

    Scopes: lead:lookup

    Parameters

    • domain (query, string | null)
    • phone (query, string | null)
    • name (query, string | null)
    • city (query, string | null)
    • country (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    POST/v1/organizations:matchOrganizations Match

    Match up to 100 records in one transaction: insufficient credits roll the batch back.

    Scopes: lead:lookup

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body MatchBody

    • records (MatchRecord[], required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/organizations/{organization_id}Organization

    Organization for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • organization_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    GET/v1/organizations/{organization_id}/evidenceOrganization Evidence

    Organization Evidence for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • organization_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.

    partner

    GET/v1/partner/tenantsList Partner Tenants

    List Partner Tenants for the authenticated tenant.

    Scopes: tenant:provision

    Parameters

    • external_ref (query, string | null)
    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/partner/tenantsCreate Partner Tenant

    Create Partner Tenant for the authenticated tenant.

    Scopes: tenant:provision

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body PartnerTenantBody

    • name (string, required)
    • plan_key (string | null)
    • external_ref (string | null)
    • owner_email (string | null)
    • api_key_scopes (string[] | null)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/partner/tenants/{tenant_id}Get Partner Tenant

    Get Partner Tenant for the authenticated tenant.

    Scopes: tenant:provision

    Parameters

    • tenant_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    POST/v1/partner/tenants/{tenant_id}/creditsTransfer Partner Credits

    Move credits from the partner's balance to a child; the partner funds what it hands out.

    Scopes: tenant:provision

    Parameters

    • tenant_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body CreditTransferBody

    • credits (integer, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/admin/partner-keysCreate Partner Key

    Mint the only kind of key that can carry tenant:provision (platform admins only).

    Scopes: platform_admin

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body PartnerKeyBody

    • tenant_id (string, required)
    • name (string, required)
    • scopes (string[])
    • expires_at (string | null)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    sales

    GET/v1/leadsLeads

    Leads for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • stage (query, string | null)
    • owner (query, string | null)
    • tag (query, string | null)
    • list_id (query, string | null)
    • min_score (query, number | null)
    • q (query, string | null)
    • external_ref (query, string | null)
    • updated_since (query, string | null)
    • sort (query, string)
    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/leadsCreate Lead

    Create Lead for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body LeadCreate

    • organization_id (string, required)
    • external_ref (string | null)
    • pipeline_stage_id (string | null)
    • owner_user_id (string | null)
    • overrides (object)
    • manual_contacts (object[])

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/leads/{lead_id}Get Lead

    Get Lead for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • lead_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/leads/{lead_id}Patch Lead

    Patch Lead for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)

    Request body LeadPatch

    • external_ref (string | null)
    • pipeline_stage_id (string | null)
    • owner_user_id (string | null)
    • custom_score (number | null)
    • opportunity_value (number | null)
    • currency (string | null)
    • do_not_contact (boolean | null)
    • overrides (object | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/leads/{lead_id}Delete Lead

    Delete Lead for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/leads/{lead_id}/notesList Notes

    List Notes for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • lead_id (path, string, required)
    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/leads/{lead_id}/notesCreate Note

    Create Note for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body NoteBody

    • body (string, required)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    PATCH/v1/leads/{lead_id}/notes/{note_id}Patch Note

    Patch Note for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)
    • note_id (path, string, required)

    Request body NoteBody

    • body (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/leads/{lead_id}/notes/{note_id}Delete Note

    Delete Note for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)
    • note_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/leads/{lead_id}/tagsAdd Tag

    Add Tag for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body TagBody

    • name (string, required)
    • color (string | null)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/leads/{lead_id}/tags/{tag_id}Remove Tag

    Remove Tag for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)
    • tag_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/leads/{lead_id}/assigndeprecatedAssign Lead

    Assign Lead for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)

    Request body AssignBody

    • owner_user_id (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/leads/{lead_id}:assignAssign Lead

    Assign Lead for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)

    Request body AssignBody

    • owner_user_id (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/leads/{lead_id}/interactionsInteractions

    Interactions for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • lead_id (path, string, required)
    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/leads/{lead_id}/interactionsAdd Interaction

    Add Interaction for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • lead_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body InteractionBody

    • kind (string, required)
    • subject (string | null)
    • body (string)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/pipeline-stagesGet Stages

    Get Stages for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/pipeline-stagesCreate Stage

    Create Stage for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body StageBody

    • name (string, required)
    • position (integer, required)
    • is_won (boolean)
    • is_lost (boolean)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/pipeline-stages/{stage_id}Get Stage

    Get Stage for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • stage_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/pipeline-stages/{stage_id}Reorder Stage

    Reorder Stage for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • stage_id (path, string, required)

    Request body StageBody

    • name (string, required)
    • position (integer, required)
    • is_won (boolean)
    • is_lost (boolean)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/pipeline-stages/{stage_id}Delete Stage

    Delete Stage for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • stage_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/listsGet Lists

    Get Lists for the authenticated tenant.

    Scopes: list:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/listsCreate List

    Create List for the authenticated tenant.

    Scopes: list:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body ListBody

    • name (string, required)
    • description (string)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/lists/{list_id}Get List

    Get List for the authenticated tenant.

    Scopes: list:read

    Parameters

    • list_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/lists/{list_id}Patch List

    Patch List for the authenticated tenant.

    Scopes: list:manage

    Parameters

    • list_id (path, string, required)

    Request body ListBody

    • name (string, required)
    • description (string)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/lists/{list_id}Delete List

    Delete List for the authenticated tenant.

    Scopes: list:manage

    Parameters

    • list_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/lists/{list_id}/membersGet List Members

    Get List Members for the authenticated tenant.

    Scopes: list:read

    Parameters

    • list_id (path, string, required)
    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/lists/{list_id}/membersAdd Members

    Add Members for the authenticated tenant.

    Scopes: list:manage

    Parameters

    • list_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body MembersBody

    • lead_ids (string[], required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/lists/{list_id}/membersRemove Members

    Remove Members for the authenticated tenant.

    Scopes: list:manage

    Parameters

    • list_id (path, string, required)

    Request body MembersBody

    • lead_ids (string[], required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/opportunitiesGet Opportunities

    Get Opportunities for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/opportunitiesCreate Opportunity

    Create Opportunity for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body OpportunityBody

    • lead_id (string, required)
    • name (string, required)
    • amount (number, required)
    • currency (string)
    • status (string)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/opportunities/{opportunity_id}Get Opportunity

    Get Opportunity for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • opportunity_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/opportunities/{opportunity_id}Patch Opportunity

    Patch Opportunity for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • opportunity_id (path, string, required)

    Request body OpportunityPatch

    • name (string | null)
    • amount (number | null)
    • currency (string | null)
    • status (string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/opportunities/{opportunity_id}Delete Opportunity

    Delete Opportunity for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • opportunity_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/suppressionsGet Suppressions

    Get Suppressions for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/suppressionsCreate Suppression

    Create Suppression for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body SuppressionBody

    • kind (string, required)
    • value (string, required)
    • reason (string)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/suppressions/{suppression_id}Get Suppression

    Get Suppression for the authenticated tenant.

    Scopes: lead:read

    Parameters

    • suppression_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/suppressions/{suppression_id}Patch Suppression

    Patch Suppression for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • suppression_id (path, string, required)

    Request body SuppressionBody

    • kind (string, required)
    • value (string, required)
    • reason (string)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/suppressions/{suppression_id}Delete Suppression

    Delete Suppression for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • suppression_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    searches

    GET/v1/campaignsCampaigns

    Campaigns for the authenticated tenant.

    Scopes: search:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/campaignsCreate Campaign

    Create Campaign for the authenticated tenant.

    Scopes: search:create

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body CampaignBody

    • name (string, required)
    • product_id (string | null)
    • icp_id (string | null)
    • status (string)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/campaigns/{campaign_id}Get Campaign

    Get Campaign for the authenticated tenant.

    Scopes: search:read

    Parameters

    • campaign_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/campaigns/{campaign_id}Patch Campaign

    Patch Campaign for the authenticated tenant.

    Scopes: search:create

    Parameters

    • campaign_id (path, string, required)

    Request body CampaignBody

    • name (string, required)
    • product_id (string | null)
    • icp_id (string | null)
    • status (string)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    DELETE/v1/campaigns/{campaign_id}Delete Campaign

    Delete Campaign for the authenticated tenant.

    Scopes: search:create

    Parameters

    • campaign_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/searchesGet Searches

    Get Searches for the authenticated tenant.

    Scopes: search:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/searchesCreate Search

    Create Search for the authenticated tenant.

    Scopes: search:create

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body SearchDefinition

    • query (string, required)
    • industry (string | null)
    • location (Location, required)
    • max_results (integer, required)
    • company_size (string | null)
    • must_have (string[])
    • prefer (string[])
    • exclude (string[])
    • sources (string[])
    • depth (string)
    • product_id (string | null)
    • icp_id (string | null)
    • campaign_id (string | null)
    • webhook_endpoint_id (string | null)

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/searches/{search_id}Get Search

    Get Search for the authenticated tenant.

    Scopes: search:read

    Parameters

    • search_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    DELETE/v1/searches/{search_id}Cancel Search

    Cancel Search for the authenticated tenant.

    Scopes: search:create

    Parameters

    • search_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/searches/{search_id}/resultsSearch Results

    Search Results for the authenticated tenant.

    Scopes: search:read

    Parameters

    • search_id (path, string, required)
    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/searches/{search_id}/results:promotePromote Results

    Promote Results for the authenticated tenant.

    Scopes: lead:write

    Parameters

    • search_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body PromoteBody

    • result_ids (string[] | null)
    • top_n (integer | null)
    • list_id (string | null)
    • pipeline_stage_id (string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/saved-searchesGet Saved Searches

    Get Saved Searches for the authenticated tenant.

    Scopes: search:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/saved-searchesSave Search

    Save Search for the authenticated tenant.

    Scopes: search:create

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body SavedSearchBody

    • name (string, required)
    • definition (SearchDefinition, required)
    • schedule ("daily" | "weekly" | "monthly" | null)
    • timezone (string)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    GET/v1/saved-searches/{saved_search_id}Get Saved Search

    Get Saved Search for the authenticated tenant.

    Scopes: search:read

    Parameters

    • saved_search_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/saved-searches/{saved_search_id}Patch Saved Search

    Patch Saved Search for the authenticated tenant.

    Scopes: search:create

    Parameters

    • saved_search_id (path, string, required)

    Request body SavedSearchPatch

    • name (string | null)
    • definition (SearchDefinition | null)
    • schedule ("daily" | "weekly" | "monthly" | null)
    • timezone (string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    DELETE/v1/saved-searches/{saved_search_id}Delete Saved Search

    Delete Saved Search for the authenticated tenant.

    Scopes: search:create

    Parameters

    • saved_search_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.
    POST/v1/saved-searches/{saved_search_id}:runRun Saved Search

    Run Saved Search for the authenticated tenant.

    Scopes: search:create

    Parameters

    • saved_search_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    • 402 RFC 9457 problem response.

    tenancy

    GET/v1/tenantsList Tenants

    List Tenants for the authenticated tenant.

    Scopes: any valid credential

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    POST/v1/tenantsCreate Tenant

    Create Tenant for the authenticated tenant.

    Scopes: tenant:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body TenantBody

    • name (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/membersMembers

    Members for the authenticated tenant.

    Scopes: member:manage

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    PATCH/v1/members/{user_id}Change Member

    Change Member for the authenticated tenant.

    Scopes: member:manage

    Parameters

    • user_id (path, string, required)

    Request body MemberRoleBody

    • role (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/members/{user_id}Remove Member

    Remove Member for the authenticated tenant.

    Scopes: member:manage

    Parameters

    • user_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/invitationsList Invitations

    List Invitations for the authenticated tenant.

    Scopes: member:manage

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/invitationsInvite

    Invite for the authenticated tenant.

    Scopes: member:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body InvitationBody

    • email (string, required)
    • role (string)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/invitations/{invitation_id}Revoke Invitation

    Revoke Invitation for the authenticated tenant.

    Scopes: member:manage

    Parameters

    • invitation_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/tenantGet Tenant Settings

    Get Tenant Settings for the authenticated tenant.

    Scopes: tenant:manage

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    PATCH/v1/tenantPatch Tenant Settings

    Patch Tenant Settings for the authenticated tenant.

    Scopes: tenant:manage

    Request body TenantSettingsBody

    • name (string | null)
    • disabled_sources (string[] | null)
    • credits_low_threshold (integer | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/invitations/acceptAccept Invitation

    Accept Invitation for the authenticated tenant.

    Scopes: any valid credential

    Request body AcceptInvitationBody

    • token (string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/tenant:request-deletionRequest Tenant Deletion

    Mark the tenant for deletion; data is purged by operators after the grace period.

    Scopes: tenant:manage

    Responses

    • 202 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/tenant:cancel-deletionCancel Tenant Deletion

    Undo a deletion request while the grace period is still running (owner session only). Not a create and naturally idempotent (a second call finds nothing pending), so it carries no Idempotency-Key, like request-deletion.

    Scopes: tenant:manage

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    usage

    GET/v1/creditsCredits

    Credits for the authenticated tenant.

    Scopes: usage:read

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    GET/v1/billingBilling

    Billing for the authenticated tenant.

    Scopes: usage:read

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    GET/v1/credits/ledgerLedger

    Ledger for the authenticated tenant.

    Scopes: usage:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)
    • offset (query, integer) Deprecated: use `cursor` / `next_cursor`.

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    GET/v1/usageUsage

    Usage for the authenticated tenant.

    Scopes: usage:read

    Parameters

    • from (query, string | null)
    • to (query, string | null)
    • group_by (query, string)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.

    watchlist

    GET/v1/watchlistList Watchlist

    List Watchlist for the authenticated tenant.

    Scopes: watchlist:read

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/watchlistCreate Watch

    Create Watch for the authenticated tenant.

    Scopes: watchlist:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body WatchBody

    • organization_id (string | null)
    • saved_search_id (string | null)
    • cadence ("daily" | "weekly")

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/watchlist/{watchlist_id}Delete Watch

    Delete Watch for the authenticated tenant.

    Scopes: watchlist:manage

    Parameters

    • watchlist_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.

    webhooks

    GET/v1/webhooks/event-typesEvent Types

    Event Types for the authenticated tenant.

    Scopes: webhook:manage

    Responses

    • 200 Successful Response
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    GET/v1/webhooksList Endpoints

    List Endpoints for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/webhooksCreate Endpoint

    Create Endpoint for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Request body EndpointBody

    • url (string, required)
    • event_types (string[], required)

    Responses

    • 201 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/webhooks/{endpoint_id}Get Endpoint

    One endpoint; the signing secret is never readable after creation or rotation.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    PATCH/v1/webhooks/{endpoint_id}Update Endpoint

    Update Endpoint for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)

    Request body EndpointBody

    • url (string, required)
    • event_types (string[], required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    DELETE/v1/webhooks/{endpoint_id}Delete Endpoint

    Delete Endpoint for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)

    Responses

    • 204 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/webhooks/{endpoint_id}/rotate-secretdeprecatedRotate Secret

    Rotate Secret for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/webhooks/{endpoint_id}:rotateSecretRotate Secret

    Rotate Secret for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/webhooks/{endpoint_id}/testdeprecatedTest Endpoint

    Test Endpoint for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/webhooks/{endpoint_id}:testTest Endpoint

    Test Endpoint for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/webhooks/{endpoint_id}/deliveriesDeliveries

    Deliveries for the authenticated tenant.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)
    • limit (query, integer)
    • cursor (query, string | null)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    POST/v1/webhooks/{endpoint_id}/deliveries/{delivery_id}:redeliverRedeliver

    Create a new delivery attempt chain for the event behind an earlier delivery.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)
    • delivery_id (path, string, required)
    • Idempotency-Key (header, string, required) Stable key for safe request replay; scoped to the tenant and route, retained for 24 hours.

    Responses

    • 202 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    POST/v1/webhooks/{endpoint_id}:resumeResume Endpoint

    Re-enable an endpoint that was disabled after repeated failures and reset its counter.

    Scopes: webhook:manage

    Parameters

    • endpoint_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    • 409 RFC 9457 problem response.
    GET/v1/eventsList Events

    Events emitted for the tenant, oldest first, so a client can replay after downtime.

    Scopes: events:read

    Parameters

    • type (query, string | null)
    • since (query, string | null)
    • cursor (query, string | null)
    • limit (query, integer)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 400 RFC 9457 problem response.
    GET/v1/events/{event_id}Get Event

    Get Event for the authenticated tenant.

    Scopes: events:read

    Parameters

    • event_id (path, string, required)

    Responses

    • 200 Successful Response
    • 422 Validation Error
    • 401 RFC 9457 problem response.
    • 500 RFC 9457 problem response.
    • 429 RFC 9457 problem response.
    • 403 RFC 9457 problem response.
    • 404 RFC 9457 problem response.