UpLead · OpenAPI Overlay 1.0.0

API Evangelist enhancements for UpLead Account Prospector API

3 actions 3 updates update extends openapi/uplead-prospector-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for UpLead's API. It is a proposal applied on top of the contract, not a document UpLead publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-profilex-apievangelist-artifactsx-spec-provenancex-rate-limitx-idempotencyx-error-envelopex-response-envelopex-billing

Targets 2

$.info
$.servers

OpenAPI Overlay

Raw ↑
# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
overlay: 1.0.0
info:
  title: API Evangelist enhancements for UpLead Account Prospector API
  version: 1.0.0
extends: openapi/uplead-prospector-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: >-
  Generated by the API Evangelist enrichment pipeline from the artifacts in this
  repository. UpLead publishes no OpenAPI of its own; the document this overlay
  extends was itself authored by API Evangelist from https://docs.uplead.com/.
  This overlay records the cross-cutting facts an integrator needs that the
  operation-level spec does not carry, without mutating the definition.
actions:
  - target: $.info
    update:
      x-apievangelist-profile: https://apis.io/provider/uplead
      x-apievangelist-artifacts:
        authentication: authentication/uplead-authentication.yml
        conventions: conventions/uplead-conventions.yml
        errors: errors/uplead-problem-types.yml
        data-model: data-model/uplead-data-model.yml
        rate-limits: rate-limits/uplead-rate-limits.yml
        plans: plans/uplead-plans-pricing.yml
        lifecycle: lifecycle/uplead-lifecycle.yml
        changelog: changelog/uplead-changelog.yml
        conformance: conformance/uplead-conformance.yml
      x-spec-provenance: >-
        Not published by UpLead. Authored by API Evangelist from the public
        documentation at https://docs.uplead.com/ on the date recorded in this
        repository's apis.yml.
  - target: $.info
    update:
      x-rate-limit:
        limit: 500
        window: minute
        scope: per-api-key
        status: 429
        headers: [X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After]
      x-idempotency:
        supported: false
        note: UpLead documents no idempotency key or replay window.
      x-error-envelope:
        shape: '{"error": {"type": "...", "message": "..."}}'
        rfc9457: false
      x-response-envelope:
        shape: '{"data": ..., "userInfo": {"availableCredits": 0}}'
        credit_balance_field: userInfo.availableCredits
      x-billing:
        model: credits
        unit: one credit per record returned
        charged_when: [company record returned, contact email_status is valid, contact email_status is accept_all]
        not_charged_when: [no results, email_status is invalid, email_status is unknown, record already purchased]
        docs: https://docs.uplead.com/#billing
  - target: $.servers
    update:
      x-primary: https://api.uplead.com/v2
      x-docs: https://docs.uplead.com/
      x-status: https://status.uplead.com/
x-operations-covered: ['prospectorSearch', 'prospectorProSearch']