Developers

The Buyerbase API

A read-only REST API over everything your agency owns. Keys are created and revoked by the agency owner under Settings.

Authentication

Every request carries an agency API key as a bearer token. A key is shown once at creation; a revoked key stops working immediately.

Authorization: Bearer bb_YOUR_KEY

Requests are limited to 120 per minute per key. Responses beyond the limit answer 429.

Pagination

List endpoints return up to 200 rows per page (default 50, set with the limit parameter) and a next_cursor. Pass it back as the cursor parameter for the next page; a null next_cursor means the end.

List people

GET /api/v1/people

The agency's people, newest first: buyers, sellers, tenants and landlords. Filter by tag with tags, a comma list such as tags=seller or tags=tenant,landlord; an unknown tag answers 400.

idfull_nameemailphonetagsstagebudget_minbudget_maxowner_idexternal_sourceexternal_idrelationscreated_atupdated_at

tags lists the person's tags. stage is the buyer pipeline column and is null for someone who never had the Buyer tag. relations lists the people linked to the person by name (partner, co_owner, co_tenant, family, representative), each with relation, full_name, email and phone.

curl -H "Authorization: Bearer bb_YOUR_KEY" \
  "https://app.buyerbase.app/api/v1/people?tags=seller&limit=50"

List buyers

GET /api/v1/buyers

The agency's buyers, newest first: the people with the Buyer tag. Kept for one version beside /api/v1/people.

idfull_nameemailphonestagebudget_minbudget_maxexternal_sourceexternal_idcreated_atupdated_at

The stage field holds the agency's column key: a built-in key such as onboarding or bid_won, or custom_ followed by twelve hexadecimal characters for a column the agency added, and a key stays the same when its column is renamed.

curl -H "Authorization: Bearer bb_YOUR_KEY" \
  "https://app.buyerbase.app/api/v1/buyers?limit=50"

List properties

GET /api/v1/properties

The agency's properties, newest first.

idtitleaddressproperty_typepricebedroomsbathroomsarea_sqmneighbourhoodstatusurlcreated_atupdated_at

curl -H "Authorization: Bearer bb_YOUR_KEY" \
  "https://app.buyerbase.app/api/v1/properties?limit=50"

List viewings

GET /api/v1/viewings

The agency's viewings, newest first.

idbuyer_idproperty_idadvisor_idstarts_atends_atstatuscreated_atupdated_at

curl -H "Authorization: Bearer bb_YOUR_KEY" \
  "https://app.buyerbase.app/api/v1/viewings?limit=50"

List document metadata

GET /api/v1/documents

Metadata of buyer documents. The API never returns file contents on this endpoint.

idbuyer_iddocument_type_idstatusfile_namecreated_atupdated_at

curl -H "Authorization: Bearer bb_YOUR_KEY" \
  "https://app.buyerbase.app/api/v1/documents?limit=50"

Download a document

GET /api/v1/documents/{id}/download

A signed URL for one document's file, valid for five minutes. Every call is written to the agency audit log, attributed to the API key that made it.

urlexpires_at

Audited per call. Use sparingly; the URL itself must not be stored.

curl -H "Authorization: Bearer bb_YOUR_KEY" \
  "https://app.buyerbase.app/api/v1/documents/DOCUMENT_ID/download"