Skip to content

API reference

API: Proof points

Markdown version

MethodPathWhat it doesScope
GET/v1/proof-pointsProof points from closed-won deals (pending, approved or rejected), each with its exact quote, speaker, date, metric and source; public is what may be used outside the dealknowledge:read
PATCH/v1/proof-points/:idApprove or reject a proof point, allow the customer's name, or fix its labels (owners, from the app; the quote can't be edited) (web app only)settings:write
POST/v1/proof-points/kb-proposalOffer approved proof points (chosen ones, or all) to the knowledge base's proof_points section, as a proposal a person acceptsknowledge:write
GET/v1/proof-points/mineWhether a mining run is queued or runningknowledge:read
POST/v1/proof-points/mineMine a closed-won deal (or deals won in the last N days, up to 10) for quantified outcomes, in the background (one run per organization at a time; poll the list); each new point is pendingknowledge:write

Examples

GET /v1/proof-points

Proof points from closed-won deals (pending, approved or rejected), each with its exact quote, speaker, date, metric and source; public is what may be used outside the deal

curl -s "https://api.closefinch.com/v1/proof-points" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/proof-points`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

POST /v1/proof-points/kb-proposal

Offer approved proof points (chosen ones, or all) to the knowledge base's proof_points section, as a proposal a person accepts

curl -s -X POST "https://api.closefinch.com/v1/proof-points/kb-proposal" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
const res = await fetch(`https://api.closefinch.com/v1/proof-points/kb-proposal`, {
  method: "POST",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}`, "content-type": "application/json" },
  body: JSON.stringify({}), // fields: see the OpenAPI schema
});
const data = await res.json();

GET /v1/proof-points/mine

Whether a mining run is queued or running

curl -s "https://api.closefinch.com/v1/proof-points/mine" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/proof-points/mine`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

POST /v1/proof-points/mine

Mine a closed-won deal (or deals won in the last N days, up to 10) for quantified outcomes, in the background (one run per organization at a time; poll the list); each new point is pending

curl -s -X POST "https://api.closefinch.com/v1/proof-points/mine" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
const res = await fetch(`https://api.closefinch.com/v1/proof-points/mine`, {
  method: "POST",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}`, "content-type": "application/json" },
  body: JSON.stringify({}), // fields: see the OpenAPI schema
});
const data = await res.json();

Request and response schemas: https://www.closefinch.com/openapi.json. All resources: API reference.

Send feedback

Tell us what's broken, confusing or missing on this page, or an idea. It goes to the team that builds the product.

Please don't include passwords or card numbers.
Only to reply about this. Never added to any mailing list.