Skip to content

API reference

API: Company signals

Markdown version

MethodPathWhat it doesScope
GET/v1/accounts/:id/companyAn account's snapshot: open roles (7/30/90-day counts), ATS boards, leaders, technologies with evidence, and its changesaccounts:read
POST/v1/accounts/:id/company/checkQueue a read of the account's careers, team and site pages, ATS boards, news and DNS now (it runs in the worker); pin keeps it watched nightlyaccounts:write
DELETE/v1/accounts/:id/company/pinStop watching an account nightly unless a monitor's audience includes itaccounts:write
GET/v1/company-changesDetected company changes, newest first: new roles, executive hires (with quotes), technologies added or removed, competitor churnprospecting:read

Examples

GET /v1/accounts/$ID/company

An account's snapshot: open roles (7/30/90-day counts), ATS boards, leaders, technologies with evidence, and its changes

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

POST /v1/accounts/$ID/company/check

Queue a read of the account's careers, team and site pages, ATS boards, news and DNS now (it runs in the worker); pin keeps it watched nightly

curl -s -X POST "https://api.closefinch.com/v1/accounts/$ID/company/check" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
const res = await fetch(`https://api.closefinch.com/v1/accounts/${id}/company/check`, {
  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();

DELETE /v1/accounts/$ID/company/pin

Stop watching an account nightly unless a monitor's audience includes it

curl -s -X DELETE "https://api.closefinch.com/v1/accounts/$ID/company/pin" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/accounts/${id}/company/pin`, {
  method: "DELETE",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

GET /v1/company-changes

Detected company changes, newest first: new roles, executive hires (with quotes), technologies added or removed, competitor churn

curl -s "https://api.closefinch.com/v1/company-changes" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/company-changes`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
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.