About the B+D GraphQL API

B+D's GraphQL API is available today for MRI Partners, can handle 240 requests per minute by default, has over 85 Collections (aka entities/tables), over 50 Mutations (aka write endpoints) and supports webhooks to notify Partners every time an existing item is updated or a new item is added to a collection their project is authorised to access.

Click here to access the Box+Dice Developer Portal

The Integration process:

  • Once signup is complete, Partner creates a test 'Project' within the Staging Developer Portal and lets MRI know.
    • MRI confirms the staging Project, and enables the integration within a sandbox testing environment.
    • MRI will organise login credentials into the sandbox, so that the Partner can complete end to end testing.
  • Once the Partner has familiarised themselves with the API's behaviour, and are ready to go live, then they create a Project in the production Developer Portal and let MRI know
  • MRI confirms the Project, and makes the integration tile available for B+D clients.
  • An authorised user from each mutual client can then visit the B+D self-serve integrations page and enable the Partners integration. 

API Changelog

28-July-2026

New Fields

  • Contact.Activities
  • Contact.Categories
  • Contact.OrganisationType

14-July-2026

New API Feature

  • So that integrator partners can be immediately informed when a mutual client enabled their integration tile within the B+D UI, B+D Webhooks now include an event type:
    • collections_changed - sent when collection items are updated. Payload includes: event, agencyIds, collections
    • agency_enabled - sent when a new agency enables an integrator's project. Payload includes: event, agencyIds
  • Updated collection filtering to support ids argument for requesting specific subsets of related items

New Collections

  • SolicitorCompanies

New Items

  • ListingLinks
  • SolicitorCompany

New Fields

  • SalesVoucher.Discount

New Mutations

  • RegistrationCreate
  • RegistrationUpdate 
  • RegistrationDelete
  • RentalInspectionCreate 
  • RentalInspectionUpdate
  • RentalInspectionDelete
  • RentalListingUpdate
  • SalesInspectionCreate
  • SalesInspectionUpdate
  • SalesInspectionDelete

Bugfix

  • Fixed issue with query scan window to prevent pagination stalls
  • ContactSearch and SalesListingSeach now more closely match the logic of our in-app 'Quick Search' feature
  • SalesVoucher fields now correctly subtracts commission discounts from gross commission calculations

Deprecated

  • Registration.PriceTo - Use Registration.PriceInterested instead
  • SalesListing.VirtualTourUrl - Use ListingLinks instead
  • SalesListing.YoutubeUrl - Use ListingLinks instead
  • SalesListing.ThreeDTour - Use ListingLinks instead

 

 

12-June-2026

New Collections

  • AppraisalCancelReasons
  • RentalAppraisals

New Items

  • AppraisalCancelReason
  • RentalAppraisal

Updated Items

  • AdvertisingCopy now includes RentalListing association

  • Property now includes PropertyFeatures, PropertyStyles, PropertyViews, and BuildingMaterials associations

New Fields

  • Contact.CreatedAt
  • Property.CreatedAt
  • SalesListing.AppraisalCancelledDate
  • SalesListing.AppraisalCancelledReason
  • SalesListing.Auction
  • SalesListing.AuthorityExpiryDate
  • SalesListing.CloseLikeihood
  • SalesListing.ExpectedCloseDate
  • SalesListing.ExpectedCommission
  • SalesListing.FeaturePropertyTypeId
  • SalesListing.FileRef
  • SalesListing.ListedAt
  • SalesListing.ListingSourceId
  • SalesListing.MediaVendorWebReference
  • SalesListing.PriceGroupId
  • SalesListing.SaleCancelDate
  • SalesListing.StatusEnum
  • SalesListing.SolicitorRef

 

 

22-May-2026

New Collections

  • ListingExternalReferences

New Items 

  • ListingExternalReference

New field

  • Comment.Visibility

Updated Queries

  • SalesListingSearch.status

Updated Mutations

  • CommentCreate Visibility
  • CommentUpdate Visibility 

 

20-May-2026

New Collections

  • CommissionItems
  • ReceiptItems
  • Receipts
  • SalesInvoices 

New Items

  • CommissionItem
  • ReceiptItem
  • Receipt
  • SalesInvoice

8-May-2026

New Collections

  • CompanyAccounts
  • Ledgers
  • Transactions

New Items

  • CompanyAccount
  • Ledger
  • Transaction

22-Apr-2026

New Mutations

  • ContactActivityCreate
  • ContactActivityUpdate
  • ContactUpdate
  • ListingAssignTag
  • ListingUnassignTag
  • RelationshipCreate
  • RelationshipUpdate

New Collections 

  • Projects
  • RentalInspections

New Items

  • Locality
  • Project
  • RentalInspection

New Fields

  • Property.project
  • Property.projectId
  • RentalListing.status
  • RentalListing.displayPrice
  • RentalListing.priceFrom
  • RentalListing.priceTo
  • RentalListing.pricePeriod
  • RentalListing.priceUndisclosed
  • RentalListing.rentalType
  • RentalListing.addressUndisclosed
  • RentalListing.url
  • RentalListing.rentalInspections
  • RentalListing.tenantCounts

Bugfixes

  • Fixed Developer API webhook queries to use integrator_project
  • Fixed case-sensitive behaviour in 'search' queries like salesListingSearch

27-Feb-2026

New Items

  • ListingTag

New Collections

  • ListingTagCollection

New Mutations

  • ContactAssignCategory

  • ContactCategoryTypeCreate

  • ContactCategoryTypeDelete

  • ContactCategoryTypeUpdate

  • ContactUnassignCategory

  • GenerateReaXml
  • ListingTagTypeCreate
  • ListingTagTypeDelete
  • ListingTagTypeUpdate

24-Feb-2026

New Items

  • Agent
  • PropertySoldOutside

New Collections

  • AgentCollection
  • PropertySoldOutsideCollection

New Mutations

  • BuyingCriteriaCreate
  • BuyingCriteriaDelete
  • BuyingCriteriaUpdate
  • LeadFlowCreate
  • PropertyAssignTag
  • PropertyBatchCreate
  • PropertyBatchUpdate
  • PropertyCreate
  • PropertySoldOutsideCreate
  • PropertyTagTypeCreate
  • PropertyUnassignTag
  • PropertyUpdate
  • SalesListingCreate
  • SalesListingMarkSold
  • SalesListingUpdate
  • SalesVoucherUpdate

 

16-Feb-2026

For easier account mapping during end user onboarding, we've added a reference identifier into the Integration Tile. Map this reference to agencies.id, accessible via our Developer API. 

13-Feb-2026  

New Queries

  • consultantSearch
  • contactSearch 
  • propertySearch 
  • rentalListingSearch 
  • salesListingSearch 

New Collections

  • AreaCollection

New Items

  • Area
  • SaleConditionType

New Fields

  • 'AreaType' added to Area
  • 'kind' added to SalesImage

New Mutations

  • AppraisalCreate
  • AppraisalUpdate
  • CommentBatchCreate
  • CommentCreate
  • CommentDelete
  • CommentUpdate
  • EnquiryCreate
  • PropertyAssignTag
  • PropertyBatchCreate
  • PropertyBatchUpdate
  • PropertyCreate
  • PropertyTagTypeCreate
  • PropertyUnassignTag
  • PropertyUpdate
  • RentalAppraisalList
  • SalesAppraisalList
  • SalesListingCreate
  • SalesListingMarkSold
  • SalesListingUpdate
  • SalesVoucherUpdate

 

Articles in this section