The RealScout API lets you connect your own RealScout data to scripts, integrations, and AI coding tools. It's available to every agent. Use it to pull your contacts and their activity into other tools, add contacts from systems you run yourself, or automate tasks like tagging and archiving.
What you can do with the API
Contacts
List, search, view, add, and edit your contacts. You can also add and remove tags, archive and unarchive, and turn Auto Nurture on or off, up to 100 contacts at a time.
View only
Contact activity: views, saves, ratings, comments, showing requests, and report views
Conversations and their messages
Alerts: Listing Alerts, Market Alerts, Home Value Alerts, and alert templates
Listing Links and Search Links
Your account
View your own account details.
Each token only sees the data of the agent who created it. There's no team, brokerage, or manager-level access.
What the API can't do yet
Send anything. No emails, texts, messages, or alert sends.
Create or edit alerts. Alerts can be viewed but not changed.
Delete contacts. You can archive them instead.
Notify your tools when something changes. There are no webhooks, so your tool has to check for updates itself.
Check for a built-in integration first
RealScout already syncs directly with Follow Up Boss, Cloze, kvCORE, MoxiWorks, and Rechat. If you use one of these, turn it on from the Integrations page instead of building your own sync.
Don't run a custom API sync and a built-in integration against the same CRM. Both would update the same contacts, which can cause duplicate changes or loops.
You can still use the API alongside a built-in integration for things your CRM doesn't manage, like tags, favorites, alert preferences, archiving, and Auto Nurture. Changes to name, phone, address, or lead source on CRM-synced contacts should be made in your CRM. If you make them through the API, the next CRM update will overwrite them.
Create your API token
In RealScout, go to Integrations → API.
Create a new token and choose its scopes, which control what it's allowed to do.
Copy the token right away. It's only shown once and can't be recovered later. If you lose it, create a new one.
A few tips:
Start with a read-only token until you trust your workflow. Only add
contacts:writewhen a tool needs to change contacts.Create a separate token for each tool. That way you can revoke one without breaking the others.
Tokens expire after 90 days. When one expires, create a new token and update your tool with it.
Keep your token safe
Your token works like a password.
Never paste it into an AI chat (Claude, ChatGPT, or similar), an email, a shared doc, a screenshot, or a support ticket.
If a token ends up somewhere it shouldn't, revoke it right away from Integrations → API and create a new one. Revoking takes effect immediately.
Store it in an environment variable named
REALSCOUT_API_TOKENso your tools can read it without you typing it in. The full docs include step-by-step instructions for Mac and Windows.
Using the API with AI tools
The API works with AI coding tools that run on your computer, such as Claude Code, Cursor, and Codex. It doesn't yet work with Claude.ai or ChatGPT chat, because those apps have no safe way to accept a token.
Once you're set up, you can ask your AI tool things like:
"List my contacts with the highest Scout Score."
"Which of my contacts were active this week?"
"Tag everyone who viewed a listing in Henderson with Henderson."
Before letting a tool make changes, ask it to show you what it plans to change first. The full docs include a starter prompt you can copy into your AI tool.
Usage limits
Type of request | Limit per token |
Lists (pages of results) | 60 per minute |
Single record lookups | 300 per minute |
Changes (writes) | 120 per minute |
Lists return 25 results by default and up to 100 per page. Creating more tokens doesn't raise your account's overall limit.
Common errors
Error | What it means | What to do |
| Token is missing, wrong, revoked, or expired (tokens expire after 90 days) | Create a new token in Integrations → API |
| Token works but isn't allowed to make this call | Create a token with the needed scope |
| Record doesn't exist or isn't yours | Double-check the contact or alert ID |
| Too many requests | Wait the number of seconds in the |
Need help?
If a request fails, include its request ID when you contact us. You'll find it in every error message and in the X-Request-Id header of every response. It lets us find the exact call. Please never send us your token.
Call 650-397-6500 (Mon–Fri, 6am–6pm PT), email support@realscout.com, or click the ? icon in RealScout.
Full API documentation
For endpoint details, token safety steps, and the guide to building a contact sync, see the RealScout API documentation.