sdk.Agents fetches the brand's agent roster — the brokerage's users, with their
contact details, profile images, and social links. Use it to build an agent directory
("Meet our agents") or an agent picker on your site.
Portal-only. Requests are routed through the portal, which resolves the brand from the current domain. On a hostname with no registered portal these methods reject — see portals in the SDK overview.
list(params)Fetches the roster, paginated:
const sdk = new Rechat.Sdk()
const { data, info } = await sdk.Agents.list({ limit: 20, start: 0 })
data.forEach(agent => {
console.log(agent.display_name, agent.email, agent.profile_image_url)
})
console.log(`Showing ${info.count} of ${info.total}`)
| Param | Default | Description |
|---|---|---|
q |
- | Filter the roster by name, email, or MLS id |
limit |
20 |
Results per page |
start |
0 |
Pagination cursor: index of the first member to return |
search(params)Autocomplete-friendly variant of list: a small result set by default (limit: 5),
and failures resolve to an empty list so a typeahead never tears the page down. Use
list when errors should surface.
input.addEventListener('input', async () => {
const { data } = await sdk.Agents.search({ q: input.value })
renderSuggestions(data)
})
get(id)Fetches a single roster member by user id:
const agent = await sdk.Agents.get('3f9c8d2a-…')
Each agent is a Rechat user:
| Field | Description |
|---|---|
id |
User id |
first_name, last_name, display_name |
Name (display_name is always set) |
email, phone_number |
Contact details |
profile_image_url, cover_image_url |
Images |
user_type |
e.g. 'Agent' |
designation |
Professional designations, e.g. 'ABR, CRS' |
website, instagram, facebook, twitter, linkedin, youtube |
Links |