API reference

API: Glossary

Method	Path	What it does	Scope
GET	`/v1/glossary`	The organization's terms, acronyms, metric definitions and calendar rules (read by every agent)	`knowledge:read`
POST	`/v1/glossary`	Define a term, acronym, metric or calendar rule (owners and admins)	`knowledge:write`
PATCH	`/v1/glossary/:id`	Change or archive a term (a new version; history is kept)	`knowledge:write`
GET	`/v1/glossary/:id/history`	Every version of a term	`knowledge:read`
GET	`/v1/glossary/:id/value`	A metric's current value from the CRM, the fiscal period it covers, and its lineage (what it reads and where those values came from)	`knowledge:read`
GET	`/v1/glossary/match`	Terms mentioned in a text (as agents receive them)	`knowledge:read`
PUT	`/v1/settings/calendar`	Calendar rules: the month the fiscal year starts and the first day of the week (owner)	`settings:write`

Examples

GET /v1/glossary

The organization's terms, acronyms, metric definitions and calendar rules (read by every agent)

curl -s "https://api.closefinch.com/v1/glossary" \
  -H "Authorization: Bearer $RA_API_KEY"

const res = await fetch(`https://api.closefinch.com/v1/glossary`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

POST /v1/glossary

Define a term, acronym, metric or calendar rule (owners and admins)

curl -s -X POST "https://api.closefinch.com/v1/glossary" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

const res = await fetch(`https://api.closefinch.com/v1/glossary`, {
  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();

PATCH /v1/glossary/$ID

Change or archive a term (a new version; history is kept)

curl -s -X PATCH "https://api.closefinch.com/v1/glossary/$ID" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

const res = await fetch(`https://api.closefinch.com/v1/glossary/${id}`, {
  method: "PATCH",
  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/glossary/$ID/history

Every version of a term

curl -s "https://api.closefinch.com/v1/glossary/$ID/history" \
  -H "Authorization: Bearer $RA_API_KEY"

const res = await fetch(`https://api.closefinch.com/v1/glossary/${id}/history`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

GET /v1/glossary/$ID/value

A metric's current value from the CRM, the fiscal period it covers, and its lineage (what it reads and where those values came from)

curl -s "https://api.closefinch.com/v1/glossary/$ID/value" \
  -H "Authorization: Bearer $RA_API_KEY"

const res = await fetch(`https://api.closefinch.com/v1/glossary/${id}/value`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

GET /v1/glossary/match

Terms mentioned in a text (as agents receive them)

curl -s "https://api.closefinch.com/v1/glossary/match" \
  -H "Authorization: Bearer $RA_API_KEY"

const res = await fetch(`https://api.closefinch.com/v1/glossary/match`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

PUT /v1/settings/calendar

Calendar rules: the month the fiscal year starts and the first day of the week (owner)

curl -s -X PUT "https://api.closefinch.com/v1/settings/calendar" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

const res = await fetch(`https://api.closefinch.com/v1/settings/calendar`, {
  method: "PUT",
  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.