What works today
The API works with AI coding tools that run on your computer and can make web requests: Claude Code, Cursor and Codex. They read your token from the REALSCOUT_API_TOKEN environment variable (see Keeping your token safe) and call the API for you.
The API doesn't yet work with Claude.ai or ChatGPT chat. Those apps have no way to accept a token safely, and pasting it into the chat isn't safe.
Getting started
Copy the starter prompt beside this guide into your AI tool. It tells the tool where this reference is, the base URL, and to read your token from REALSCOUT_API_TOKEN. Finish the last line with what you want, for example:
- "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."
Your tool should call GET /me first. That confirms the token works and shows which scopes it has.
Before you let a tool make changes
A token with contacts:write lets the tool edit, tag and archive your contacts. Ask the tool to show you what it plans to change before it runs, and start with a read-only token until you trust the workflow.
I want to use the RealScout API to work with my own RealScout data.
Read the API reference first: https://bump.sh/realscout/doc/realscout-api/llms.txt
- Base URL: https://www.realscout.com/api/agent/v1
- Authenticate with the header "Authorization: Bearer <token>". My token is in the REALSCOUT_API_TOKEN environment variable. Read it from there; never print it, log it, or ask me to paste it.
- Start by calling GET /me to confirm the token works and to see which scopes it has.
Then help me with: