Official vendor OpenAPI document · agent-readyCRMContact ManagementapiKey5 EndpointsREST
For Agents
Create, list, update, and delete sales leads across Salesforce, HubSpot, Pipedrive, Zoho, and other CRMs through one unified API.
Use for: Create a new lead from a website demo request form, List all leads created in the last 24 hours, Update a lead's status to 'qualified' after a discovery call, Delete a duplicate lead that was created twice
Not supported: Does not handle deals, opportunities, accounts, or contact records - use for the lead resource lifecycle only; switch to the Apideck CRM Unified API for downstream pipeline operations.
The Apideck Lead API is a focused unified interface for working with sales leads across CRMs and lead-capture tools including Salesforce, HubSpot, Pipedrive, and Zoho. Five endpoints cover the full CRUD lifecycle on a single normalised lead resource - list, create, get, update, and delete - so a marketing form, chat widget, or AI agent can push qualified leads into whichever CRM the customer uses without per-vendor code. Authentication uses the standard Apideck Authorization header alongside x-apideck-app-id and x-apideck-consumer-id.
Install Jentic One Beta
Connect the Lead API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Lead API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fapideck.com%2Flead" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fapideck.com%2Flead" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Lead API.
Create a lead with name, company, email, phone, and source attribution via POST /lead/leads
List existing leads with cursor-based pagination through GET /lead/leads
Look up a single lead by ID to inspect its current state and ownership
Update a lead's owner, status, or custom fields with PATCH /lead/leads/{id}
Delete a lead from the connected CRM with DELETE /lead/leads/{id}
Push leads from a form or chatbot into whichever CRM the customer connects without per-vendor logic
Use Cases
Patterns agents use Lead API for, with concrete tasks.
★ Form-to-CRM Lead Capture
Wire a marketing form, chat widget, or event sign-up to push leads into whichever CRM the customer has connected (Salesforce, HubSpot, Pipedrive, Zoho). POST /lead/leads accepts the same payload across providers and returns the resulting lead ID, so the integration is one HTTP call regardless of CRM. Useful for SaaS products that don't want to build five CRM integrations.
Create a lead with name 'Jane Doe', company 'Acme Corp', email 'jane@acme.com', source 'demo-request' in the connected CRM and return the resulting lead_id
Lead Status Sync
Keep an external sales tool's lead status in sync with the customer's CRM. GET /lead/leads/{id} retrieves current state, PATCH /lead/leads/{id} updates owner or status, and a polling or event-driven loop reconciles changes. Works the same against any of the supported CRMs because Apideck normalises the lead schema.
For lead_id 'lead_42', PATCH the status to 'qualified' and assign owner_id 'user_77', then verify with GET /lead/leads/lead_42
Duplicate Lead Cleanup
Deduplicate inbound leads before they hit the sales team. List leads with GET /lead/leads, group by email or company domain, and delete duplicates with DELETE /lead/leads/{id}. The 5-endpoint surface keeps the cleanup script small and portable across CRMs.
List all leads, group by email, and for each group with more than one lead delete every lead except the most recently created
AI Agent Lead Capture via Jentic
An AI sales agent qualifies a website visitor in chat and files them as a lead. Through Jentic, the agent searches 'create a lead', loads the POST /lead/leads operation, and executes it with the captured details. Jentic stores the Apideck Authorization, x-apideck-app-id, and x-apideck-consumer-id headers separately so the agent never sees the raw key.
Through Jentic, search 'create a lead', load POST /lead/leads, and create a lead from the chat transcript with name, company, email, and a description summarising the conversation
Key Endpoints
5 endpoints — the apideck lead api is a focused unified interface for working with sales leads across crms and lead-capture tools including salesforce, hubspot, pipedrive, and zoho.
METHOD
PATH
DESCRIPTION
GET
/lead/leads
List leads
POST
/lead/leads
Create a lead
GET
/lead/leads/{id}
Get a lead by ID
PATCH
/lead/leads/{id}
Update a lead
DELETE
/lead/leads/{id}
Delete a lead
GET
/lead/leads
List leads
POST
/lead/leads
Create a lead
GET
/lead/leads/{id}
Get a lead by ID
PATCH
/lead/leads/{id}
Update a lead
DELETE
/lead/leads/{id}
Delete a lead
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
L
Lead API
- Non-Ready (F)0/100
52
Foundational Compliance86
Developer Experience & Jentic Compatibility61
AI-Readiness & Agent Experience94
Agent Usability50
Security0
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
52
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: C-Signals: 4
96%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
14%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
86
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: ASignals: 4
67%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
75%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
61
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: B-Signals: 4
74%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
71%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
0
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: FSignals: 1
0%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Apideck Lead API by hand means setting up its API key plus consumer and service headers, learning the unified lead shape, and normalising across lead sources yourself. Through Jentic you install once, import Apideck Lead from the API Directory, store the key once, and your agent calls it.
Permission scoping
The Apideck Lead API puts the lead id in the URL path (/lead/leads/{id}), so a rule can pin your agent to one lead: it can read and update that lead and nothing else. You choose the operations it may call, so delete is not included unless you add it.
Credential isolation
Your Apideck API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a lead' or 'update a lead record', and Jentic returns the matching Apideck Lead operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Lead API through Jentic.
What authentication does the Apideck Lead API use?
An apiKey scheme on the `Authorization` header with your Apideck application key, plus `x-apideck-app-id` and `x-apideck-consumer-id` headers. Through Jentic these are stored encrypted in the vault and injected at execution; the agent only ever holds a scoped token.
Can I push a lead into Salesforce, HubSpot, and Pipedrive with the same call?
Yes. POST /lead/leads uses the same request shape regardless of the underlying CRM. The actual provider is determined by the connection associated with the x-apideck-consumer-id; provider-specific custom fields can be passed through Apideck's custom fields mechanism.
What are the rate limits for the Apideck Lead API?
The OpenAPI spec does not publish per-endpoint rate limits. Apideck applies plan-based limits at unify.apideck.com plus per-connector limits passed through from the underlying CRM (Salesforce's per-org daily limit, HubSpot's burst limits, etc.). See https://developers.apideck.com for current numbers.
How do I create a lead through Jentic?
Install with `pip install jentic`, then run the search query 'create a lead'. Jentic returns POST /lead/leads - load its schema, supply name, company, email, and any source attribution, then execute. The lead lands in whichever CRM the consumer has connected.
Does the Lead API support custom fields from my CRM?
Yes - Apideck Unified APIs accept custom fields on the lead payload that pass through to the underlying CRM. Use the Vault API's custom-mappings endpoints to map your custom field IDs to the connector's native field IDs before sending the lead.
Can I convert a lead to an opportunity through this API?
No. The Lead API covers lead CRUD only; conversion to opportunities, accounts, or contacts is handled by the Apideck CRM Unified API. After creating or updating a lead here, switch to apideck.com/crm for downstream pipeline operations.
Can I limit what my agent is allowed to do with the Apideck Lead API?
Yes. Because Jentic One is self-hosted, you set the rules that decide which of the five Lead operations your agent may call, so you can allow list, get, create, and update while withholding DELETE /lead/leads/{id}. Since the lead id sits in the URL path (/lead/leads/{id}), a rule can pin the agent to a single lead, letting it read and update that one record and nothing else. Your Apideck key and consumer headers stay with your instance and are injected at execution, so the agent can only ever act within the operations you grant.
GET STARTED