API reference
API: Account
| Method | Path | What it does | Scope |
|---|---|---|---|
| GET | /v1/me | Who am I: principal, active organization, role and scopes | — |
| GET | /v1/me/email-aliases | Your other email addresses (activity from them is attributed to you once verified) (web app only) | — |
| POST | /v1/me/email-aliases | Add an address (up to 10). We email it a link to verify, valid for 24 hours. (web app only) | — |
| DELETE | /v1/me/email-aliases/:id | Remove one of your addresses (web app only) | — |
| POST | /v1/me/email-aliases/:id/resend | Send a new verification link for one of your unverified addresses (the old link stops working) (web app only) | — |
| POST | /v1/me/email-aliases/verify | Confirm an address with the token from the email (web app only) | — |
| GET | /v1/me/limits | Your plan's limits before you reach them: how much of each is used, when it resets, what stops when it's reached and what still works (web app only) | — |
| GET | /v1/me/nav | Your navigation: pinned and recent pages and records, closed sidebar groups, whether shortcuts are on, which modules and setups your organization has, and whether you put the tour away (web app only) | — |
| PATCH | /v1/me/nav | Turn keyboard shortcuts on or off, set which sidebar groups are closed, or put the free-plan tour away (or bring it back) (web app only) | — |
| PUT | /v1/me/nav/pins | Set your pinned pages and records (up to 12, in order) (web app only) | — |
| POST | /v1/me/nav/recent | Note a page or record you opened (kept to your last 12) (web app only) | — |
| PATCH | /v1/me/session-replay | Opt yourself out of session replay (your recordings are deleted), or back in (web app only) | — |
| GET | /v1/session-replay | Whether this browser session is recorded for session replay (masked; off unless an owner turned it on), the pages never recorded, and how long recordings are kept (web app only) | — |
| POST | /v1/session-replay/events | The session replay recorder's batch (masked snapshots, navigation, clicks, scrolls). Refused whole if any text isn't masked; events on sensitive pages are dropped (web app only) | — |
| POST | /v1/ui-events | Record how the app is used in this browser (first-party, no cookies beyond your session): navigation, the palette, empty searches (their length only), setup steps left, first use of a feature. Fixed ids and counts only (web app only) | — |
Examples
GET /v1/me
Who am I: principal, active organization, role and scopes
curl -s "https://api.closefinch.com/v1/me" \
-H "Authorization: Bearer $RA_API_KEY"const res = await fetch(`https://api.closefinch.com/v1/me`, {
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.