In the dashboard: Contacts → Manage Brokerages
The Hive Inspect API is a work in progress. It is available to a small group of accounts today, and the release for everyone is coming very soon. To ask for early access, message us from the chat bubble in your dashboard.
What a contact returns
A contact can have an
agency_name with no agency_id. That is a name typed as plain text that does not match any of your agencies.
Set a contact’s agency
Agencies are read-only in the API. Create and edit them on the Manage Brokerages page in the dashboard, then link contacts to them.
To remove the link, send
"agency_id": null.
Link by name instead
You can sendagency_name without an id:
- If the name matches one of your agencies, Hive links the contact to it. Upper and lower case and extra spaces do not matter.
- If it matches nothing, Hive keeps the name as plain text and the contact stays unlinked. The API never creates an agency from a name.
agency_id wins. Prefer agency_id, because a name can be misspelled.
Use the agency’s address
A contact can follow its agency’s address instead of keeping its own.- A contact with no address starts following the agency the first time you link it. The response then shows the agency’s address on the contact, with
uses_agency_addressset totrue. - Sending an address stops it. If you update any address field on a contact that follows its agency, Hive keeps your address and sets
uses_agency_addresstofalse. - You can choose. Send
"uses_agency_address": trueto follow the agency, orfalseto keep the contact’s own address.
Find contacts by agency
List everyone at an agency with theagency_id filter:
agency_id, so you can total inspections and revenue by agency.
