API reference
API: Shared background
| Method | Path | What it does | Scope |
|---|---|---|---|
| GET | /v1/me/background | Your own background (schools, past employers, programs, city) and which parts you let drafts and signals use. Private to you. (web app only) | prospecting:read |
| PUT | /v1/me/background | Change your background and opt-ins (turning an attribute off removes its matches) (web app only) | prospecting:read |
| POST | /v1/me/background/match | Queue a look for shared background with contacts at accounts that fit the ICP (it runs in the worker and can use a paid provider) (web app only) | prospecting:write |
Examples
Request and response schemas: https://www.closefinch.com/openapi.json. All resources: API reference.