What can the CloseMagnet API do?
Download MarkdownIt reads almost everything in your account, and what it writes is deliberately narrow. Its endpoints span 17 domains and the large majority are read-only. The ones that write do one of these things:
It reads almost everything in your account, and what it writes is deliberately narrow. Its endpoints span 17 domains and the large majority are read-only. The ones that write do one of these things:
- Prepare a message or blast draft that a person still has to approve.
- Put an offer or a note on your own records, and mark a task complete.
- Create or update a property, move its stage (with the assigned buyer and the assignment fee), and set its deal owners.
- Work a transaction file: reopen a task, mark a task not applicable, reassign a task, edit the file's fields, and add or update the people on it.
- Request a comp report, which is metered and must be confirmed.
The property and transaction-file writes are built to be tried safely. Each one can run as a dry run that checks everything and saves nothing. Each accepts an idempotency key, so a call retried with the same key never changes anything twice. Each answers with the full record after the change and the list of fields that changed, so the agent can check its own work. They need a scoped credential with Write on the Properties row (for the property itself) and on the Transactions row (for deal owners, tasks, transaction-file fields, people, and a stage move that records the buyer, the fee, or a note). Your automatic account token is refused by the property tools on purpose; it keeps its original job of receiving what your LeadAttractor CRM pushes in.
Everything lives under https://app.closemagnet.com and authenticates with an Authorization: Bearer header carrying a credential you mint. The domains cover leads, calls, campaigns, KPIs, buyers, properties, comps, deals, blasts, segments, transactions, flips, commissions, coaching, credits, team, and account.
What an agent can never do, and what a stage change adds to your LeadAttractor CRM, is covered in "Can a connected agent send messages or spend money?".
The full reference is in the app at Settings -> API -> API reference. It lists every route, its parameters, and the credential scope it requires, and any member of your account can read it. Read it there rather than working from a remembered count: the catalog grows as the product does.
Links to the app require your CloseMagnet login.
Related Articles
- How do I create an API credential?Only the account owner can mint one, and it happens at Settings -> API.
- What is the difference between my account API token and a scoped credential?Your account API token was minted automatically when the account was created. It sits pinned as the first row in Settings -> API with the type "Automatic", carries a fixed set of scopes, can be revealed again at any time, and can
- How do I rotate or revoke a credential?It depends which kind you have, and only the account owner can do either one.
- Which scopes should I pick?Select the fewest permissions your integration actually needs. Settings -> API shows the scopes an owner can choose. A registered system permission is not necessarily a selectable customer credential option, so follow the current