Agent-ready OpenAPI document · curated by JenticCRMDeal Pipelinebearer3 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Push new leads into a Clarkup sales pipeline after completing OAuth 2.0 authorization, suitable for inbound capture forms, chat handoff, or AI agent intake bots.
Use for: I need to push a new inbound lead into Clarkup after a chat conversation ends, Set up OAuth for a Clarkup workspace from a partner integration, Exchange an authorization code for a Clarkup access token, Create a Clarkup lead from a website contact form submission
Not supported: Does not handle deal updates, contact enrichment, or pipeline reporting - use for inbound lead creation through OAuth-authorised workspaces only.
Jentic publishes the only available OpenAPI specification for Clarkup API, keeping it validated and agent-ready. Clarkup is a sales pipeline tool focused on inbound lead capture, and its public API exposes a focused surface for OAuth authorization and lead creation. The spec covers the OAuth 2.0 authorization and token exchange endpoints plus a single Zapier-style lead creation endpoint that drops a new lead into a Clarkup pipeline. It is intentionally minimal and aimed at integration partners that need to push leads in, not browse or enrich the existing pipeline.
Install Jentic One Beta
Connect the Clarkup API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Clarkup 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%2Fclarkup.com%2Fclarkup" | 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%2Fclarkup.com%2Fclarkup" | 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 Clarkup API.
Initiate OAuth 2.0 authorization for a Clarkup workspace via /oauth/authorize
Exchange an authorization code for an access token via /oauth/token
Create a new lead in the connected Clarkup pipeline via /zapier/create-lead
Identify the authorising user from the OAuth grant before posting leads
Pass lead context such as name, email, and source so the lead lands in the correct stage
Use Cases
Patterns agents use Clarkup API for, with concrete tasks.
★ Inbound Lead Capture from Web Forms
Forward web form submissions, webinar registrations, and chatbot handoffs straight into Clarkup as new leads after a one-time OAuth connection. The /zapier/create-lead endpoint accepts the lead payload directly so partner integrations skip building a heavier sync layer.
Call /zapier/create-lead with the contact's name, email, source, and notes after a form submission, using the cached OAuth bearer token.
Partner OAuth Onboarding
Run a one-click OAuth connection flow that lets a Clarkup user authorise a third-party app to push leads into their workspace. The /oauth/authorize redirect kicks off consent and /oauth/token exchanges the resulting code for a refresh-capable access token.
Redirect the user to /oauth/authorize with client_id, scope, and redirect_uri, then post to /oauth/token with the returned code to obtain an access token.
AI Agent Lead Intake via Jentic
An AI agent that runs an outbound prospecting bot or an inbound concierge can drop qualified leads into Clarkup at the moment of capture by searching Jentic for the lead-creation operation and executing it. Jentic securely stores the OAuth bearer token so the agent never holds the secret directly.
Use the Jentic search query 'create a sales lead' to find /zapier/create-lead and execute with the qualified contact details from the conversation.
Key Endpoints
3 endpoints — jentic publishes the only available openapi specification for clarkup api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/oauth/authorize
Start the OAuth 2.0 authorization flow
POST
/oauth/token
Exchange an authorization code for an access token
POST
/zapier/create-lead
Create a new lead in the connected Clarkup workspace
GET
/oauth/authorize
Start the OAuth 2.0 authorization flow
POST
/oauth/token
Exchange an authorization code for an access token
POST
/zapier/create-lead
Create a new lead in the connected Clarkup workspace
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.
C
Clarkup API
- Foundational (C+)58/100
100
Foundational Compliance56
Developer Experience & Jentic Compatibility33
AI-Readiness & Agent Experience94
Agent Usability60
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
56
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
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.
33
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
16%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
67%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
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.
60
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
60%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
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 Clarkup by hand means running its OAuth flow to mint a bearer token, then keeping that token attached to every call against app.clarkup.com. Through Jentic you install once, import Clarkup from the API Directory, store the token once, and your agent calls it.
Permission scoping
You choose which Clarkup operations the agent may call, so you can limit it to the operations it needs, such as creating a lead, and leave the token and authorize operations out of the allowed set unless you add them.
Credential isolation
Your Clarkup token 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 in Clarkup', and Jentic returns the matching 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 Clarkup API through Jentic.
Why is there no official OpenAPI spec for Clarkup API?
Clarkup does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Clarkup API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Clarkup API use?
The API uses OAuth 2.0 authorization code flow via /oauth/authorize and /oauth/token, returning a bearer token used on /zapier/create-lead. Through Jentic the bearer token is stored in the encrypted vault and the agent receives only a scoped execution context.
Can I create a Clarkup lead with the API?
Yes. POST to /zapier/create-lead with the lead payload after completing the OAuth flow. This is the only lead-mutation endpoint in the public spec, designed for inbound capture rather than full pipeline management.
Can I read existing Clarkup leads or pipeline stages with this API?
No. The public spec only exposes lead creation and OAuth endpoints. To read or move existing leads, use the Clarkup app directly until additional endpoints are released.
How do I push a lead into Clarkup through Jentic?
Search Jentic for 'create a sales lead', load the schema for /zapier/create-lead, and execute with the lead details. The Python SDK uses await client.search, await client.load, await client.execute.
How do I complete the OAuth handshake?
Send the user to /oauth/authorize with client_id, scope, and redirect_uri. After consent Clarkup redirects with a code that you exchange at /oauth/token to receive an access token.
Can I limit what my agent is allowed to do with the Clarkup API?
Yes. Because you run Jentic One yourself, you decide which Clarkup operations the agent may call, and your own rules are what allow or block each one. You can restrict the agent to the /zapier/create-lead operation for inbound lead creation while leaving the /oauth/authorize and /oauth/token operations out of the allowed set unless you add them. The stored token is injected only at execution time, so the agent acts only within the operations you have permitted.
GET STARTED