Your CRM

Get your CRM's vocabulary

GEThttps://api.ruuster.com/v1/crm/overview

Your CRM key's identity plus the account's ponds, stages, users (agents) and smart lists, with their ids. Call it once to learn the names and ids the CRM filters take (pond=, stage=, assignedUserId=).

Authentication: x-api-key and x-email headers of an owner or admin
Rate limit: lookup call, 20 per minute per key, within the 120 per minute
Your CRM: x-crm-vendor and x-crm-key headers with your CRM's API key, used for this request only. See Connect your CRM

View as Markdown

Everything the other CRM calls' filters refer to, in one call: the ponds (pond=), the stages (stage=), the users with their ids (assignedUserId=) and the smart lists (smartListId= on Search your CRM's people), plus what Check your CRM key returns. Reads your CRM live with the key in x-crm-vendor and x-crm-key (four or five CRM calls; the key is used for this request only).

What each CRM provides: Follow Up Boss lists ponds, stages, users and smart lists. Sure Send lists stages, users and smart lists (its API doesn't list ponds). Sierra lists ponds and users; its stages are the fixed lead statuses, and it has no smart lists.

Response

Field	Description
`identity`	As Check your CRM key
`joins`	Which joins this CRM supports
`ponds[]`	`id`, `name`; null when the CRM's API doesn't list ponds
`stages[]`	Stage names (Sierra: lead statuses)
`users[]`	`id`, `name`, `email`, `role` (the first 100)
`smartLists[]`	`id`, `name`; null for Sierra

Request

curl -s "https://api.ruuster.com/v1/crm/overview" \
  -H "x-api-key: $RUUSTER_API_KEY" \
  -H "x-email: $RUUSTER_EMAIL" \
  -H "x-crm-vendor: fub" \
  -H "x-crm-key: $CRM_API_KEY"

const res = await fetch("https://api.ruuster.com/v1/crm/overview", {
  headers: {
    "x-api-key": process.env.RUUSTER_API_KEY,
    "x-email": process.env.RUUSTER_EMAIL,
    "x-crm-vendor": "fub",
    "x-crm-key": process.env.CRM_API_KEY,
  },
});
const body = await res.json();
if (!body.ok) throw new Error(`${body.error.code}: ${body.error.message} (${body.requestId})`);
console.log(body.data);

import os
import requests

res = requests.get(
    "https://api.ruuster.com/v1/crm/overview",
    headers={"x-api-key": os.environ["RUUSTER_API_KEY"], "x-email": os.environ["RUUSTER_EMAIL"], "x-crm-vendor": "fub", "x-crm-key": os.environ["CRM_API_KEY"]},
    timeout=30,
)
body = res.json()
if not body["ok"]:
    raise RuntimeError(f'{body["error"]["code"]}: {body["error"]["message"]} ({body.get("requestId")})')
print(body["data"])

{ "ok": true, "data": { "identity": { "vendor": "fub", "label": "Follow Up Boss", "account": { "id": "1234567", "name": "examplerealty" }, "user": { "id": "2", "name": "Alex Rivera", "email": "alex@examplerealty.com", "role": "Broker", "isOwner": true }, "scope": "account", "note": null }, "joins": { "followUp": true, "segmentsBy": ["pond", "stage", "agent", "tag"], "segmentsSource": "live", "ponds": true }, "ponds": [ { "id": "2", "name": "New Leads" }, { "id": "4", "name": "Inactive Buyers" }, { "id": "9", "name": "Inactive - Sellers" } ], "stages": ["Lead", "Hot Prospect", "Nurture", "Active Client", "Pending", "Closed", "Past Client", "Trash"], "users": [ { "id": "2", "name": "Alex Rivera", "email": "alex@examplerealty.com", "role": "Broker" }, { "id": "12", "name": "Jordan Price", "email": "jordan@examplerealty.com", "role": "Agent" } ], "smartLists": [ { "id": "31", "name": "Hot leads" }, { "id": "44", "name": "No contact 30 days" } ] }, "meta": { "crm": { "vendor": "fub", "label": "Follow Up Boss", "source": "Follow Up Boss, live, with your API key", "calls": 6 } } }