BDX Web API - Data Explorer

Add User To ActOn File
This endpoint is used for create ActOn lists with the structure required for the ActOn API, after creating the list with this endpoint you should send it to ActOn API using the UploadUsersFilesToActOn endpoint.

• Any parameter is required

Upload Files To ActOn.
This endpoint is used for uploading all the ActOn Lists created with the endpoint AddUserToActOnFile to the ActOn API.

• This endpoint doesn't use parameters

Get Agent Compensation.

• CommId
• BuilderId
• PartnerId

Post an answer to a question in the BHI AnswerHub site.

• Authorization
• QuestionId

Get a paged list of the answers that have been posted to a question in the BHI AnswerHub site.

• Authorization
• QuestionId
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Query
• Sort

Post a new question to the BHI AnswerHub site.

• Authorization

Creates a new user in the BHI AnswerHub site.

• Authorization

Makes a user follow an space in the BHI AnswerHub site.

• Authorization
• SpaceId
• Follower

Makes a user follow a topic in the BHI AnswerHub site.

• Authorization
• TopicId
• Follower

Get a paged list of the answers that have been posted to the BHI AnswerHub site.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Query
• Sort
• AnswerId
• QuestionId

Get a paged list of the articles that have been posted to the BHI AnswerHub site.
Articles refer to structured documents within the BHI AnswerHub knowledge base.
The Article content type is perfect for how-to's and process documentation.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Query
• Sort
• ArticleId

Get a paged list of the awards that have been installed to the BHI AnswerHub site.
Awards are a method to reward users for certain behaviors or for achieving certain landmarks in terms of the content they post on the BHI AnswerHub site.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Query
• Sort
• AwardId

Get a paged list of the comments that have been posted to the BHI AnswerHub site.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Query
• Sort
• CommentId
• QuestionId
• AnswerId

Get a paged list of the ideas that have been posted to the BHI AnswerHub site.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Query
• Sort
• IdeaId

Get a paged list of the questions that have been posted to the BHI AnswerHub site.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Query
• Sort
• QuestionId
• SpaceId
• TopicId
• Topics

Get a paged list of questions posted to the BHI AnswerHub site that are related to a specific question filter by question ID.

• Authorization
• QuestionId
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Sort

Get a paged list of the spaces that have been created in the BHI AnswerHub site.
Spaces are an organizational tool in AnswerHub that sits below a Site and above a Topic.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Sort
• SpaceId

Get a paged list of the topics that have been created in the BHI AnswerHub site.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Sort
• TopicId

Get a paged list of the users that have been created in the BHI AnswerHub site.

• Authorization
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Sort
• UserId

Get a paged list of the answers that have been posted by an user in the BHI AnswerHub site.

• Authorization
• UserId
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Sort

Get a paged list of the awards that have been earned by an user in the BHI AnswerHub site.

• Authorization
• UserId
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Sort

Get the detailed information for an user created in the BHI AnswerHub site.

• Authorization
• UserName

Get a paged list of the topics which the user is an expert in the BHI AnswerHub site.

• Authorization
• UserId
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Sort

Get a paged list of the questions that have been posted by an user in the BHI AnswerHub site.

• Authorization
• UserId
• Exclude
• Include
• IncludeOnly
• Page
• PageSize
• Sort

Makes a user unfollow an space in the BHI AnswerHub site.

• Authorization
• SpaceId
• Follower

Makes a user follow a topic in the BHI AnswerHub site.

• Authorization
• SpaceId
• Follower

Divisions by Corp Builder Id

• BuilderId

Remove API cache

Get Comments By Property.

• UserId
• ListingId
• ListingType
• ClientId

Get Comments By Agent.

• UserId

Get Comments By Agent and Client.

• UserId
• ClientId

Create Comments.

• CommentId
• UserId
• ClientId
• ListingId
• ListingType
• Author
• CommentText
• DateCreated
• DateLastChanged

Update Comments.

• CommentId
• UserId
• ClientId
• ListingId
• ListingType
• Author
• CommentText
• DateCreated
• DateLastChanged

Update Comments.

• CommentId
• IsArchived

Update Comments.

• ApiAgentClientComment

Object filled with form information

Age Restricted Communities by State

• PartnerId
• State
• ExcludeStates
• ExcludeBuilders
• ExcludeMarkets

Get Brand and Brand Showcase info, by Brand Id.

• brandId

Get Brand Testimonials, by Brand Id.

• brandId

Get Lots from a Community.

• PartnerId
• BrandId Or CommId
• Unpublished

Get Lot by Id.

• LotId
• Unpublished
• PartnerId

Retrieves a list of Cities by State.

• PartnerId
• State
• BrandId
• Unpublished

Community Details.

• PartnerId
• CommId
• IncludeBookmarks
• UserId (required when using IncludeBookmarks)

Community Testimonials.

• CommId
• BuilderId
• MaxReturnRows
• Partner Id

Community Events and Promotions.

• CommId
• BuilderId
• Unpublished
• Partner Id

All Consumer Promo Offers for a Community
Parameters:

• CommId
• Unpublished
• Partner Id

Get all brands from Mongo Db, for performance tests

Get Plan or Spec by Id.

• PartnerId
• PlanId Or SpecId
• BackFillImages
• IncludeBookmarks
• UserId (required when using IncludeBookmarks)
• ExcludeParams
• AggregateOptions

Get Basic Listing by Id.

• PartnerId
• ListingId
• BackFillImages
• IncludeBookmarks
• UserId (required when using IncludeBookmarks)
• ExcludeParams
• AggregateOptions

Get Markets by Partner, State and Brand

• PartnerId
• State
• BrandId
• Unpublished

Partner Details.

• PartnerId
• Unpublished

Partners List.

• Unpublished

List of States for Partner.

• PartnerId
• BrandId
• Unpublished

Get Ektron Content by Id.
DEPRECATED. Please use "Contents", instead.

• ContentId

Get Ektron Contents by comma-separated list of Ids, or by the Author Name.

• ContentIds
• Title
• TaxonomyIds
• TaxonomyNames
• SmartFormIds
• SmartFormNames
• FolderIds
• FolderPath
• AuthorId
• AuthorName
• SortBy
• SortOrder
• PageSize
• PageNumber
• StatusIds
• ExcludeMetadata

Get Ektron Contents By Folder Id.
DEPRECATED. Please use "Contents" with the FolderIds or FolderPath filter, instead.

• FolderId
• SortBy
• SortOrder

Get Ektron SubCategories for a Taxonomy Id.

• TaxonomyId
• Recursive

Get Ektron Sub Folders for a parent Folder Id.

• FolderId
• Recursive

Get Ektron Smart Forms (Also Known as XML Collections)

Send an Email.

• To: List of email that are going to receive the email
• From: Contains the email and name of the sender of the email
• Body: Data and Url to get the Body of the email
• ReplyTo: Set the Reply To email information
• Subject: Subject of the email
• From: Contains the email and name of the sender of the email
• CallBack: Action to be execute after the email is send

Get FeedBack By Property.

• UserId
• ClientId
• ListingId
• ListingType

Get Client Counts By Agent

• UserId

Get Agent

• UserId

Get Feedback By Agent and Client

• UserId
• ClientId

Counts By Client Id

• ClientId

Client Feedback By Agent

• UserId

GraphQL

GraphQL

Executes GraphQL Queries. Support for a POST request with JSON-encoded HTTP POST contents in form: { "query": "...", "variables" : {"myVariable": "someValue", ...} }

This endpoint allows builders to access their BDX leads in either JSON or XML. Please reach out to your account manager for token information. Get Leads.

• builderId
• token
• startDate
• endDate
• leadRecipient
• leadIdMin
• leadIdMax
• communityId
• planId
• specId
• count

Endpoint that returns a profile valid for a user /// Get Leads Extended.

• builderId
• token
• email

This endpoint returns a list of objects that contains a Profile of a user with all their corresponding leads Get Leads Extended.

• builderId
• token
• startDate
• endDate
• leadIdMin
• leadIdMax
• communityId
• planId
• specId
• email
• count

Generates Leads. This endpoint will force security, so, a PartnerId and SessionToken are mandatory. Note: Any Lead Action can be applied to any Lead Type

Generates Leads. This endpoint will force security, so, a PartnerId and SessionToken are mandatory. Note: Any Lead Action can be applied to any Lead Type

Gets user behavior information from BigQuery filtered by a list of shopper ids

Gets a requests from a customer with multiple leads to process the lead augmentation service

Gets a requests from a customer with multiple leads to process the lead augmentation service

Gets a requests from a customer with multiple leads to process the lead augmentation service on real time mode

Gets a requests from a customer who wants to know the status of a request submitted earlier

Gets a requests from a customer who wants to know the status of all request submitted since a start date

Get the results of the transaction of a customer.

Subscribe user to email results.

Get the user details.

Generates Opcity Leads.

Lasso Lead Integration. Endpoint for submitting forms to Lasso CRM.

Get likes By Agent.

• UserId

Get Likes By Agent and Client.

• UserId
• ClientId

Create a like.

• LikeId
• Like
• UserId
• ClientId
• ListingId
• ListingType
• DateCreated
• DateLastChanged

Update a like.

• LikeId
• UserId
• Like
• ClientId
• ListingId
• ListingType
• DateCreated
• DateLastChanged
• IsArchived

Update a like.

• LikeId
• IsArchived

Delete likes of a client.

• ClientId

Log Partner Event

• partnerId
• eventCode
• propertyId
• testMode

Event Logger

• PartnerId
• eventCode

Get Media Objects for Communities.

• PartnerId
• CommId
• ExcludeImages
• ExcludeVideos
• BackFillImages
• ImgTypes
• includeVideoUrls

Get Media Objects for Communities, Plans or Specs for the new Gallery Experience viewer

• PartnerId
• CommId
• PlanId
• SpecId
• extramediainfo

Get Media Objects for Plans or Specs.

• PlanId Or SpecId
• ExcludeImages
• ExcludeVideos
• ExcludeFloorPlans
• BackFillImages
• ImgTypes
• includeVideoUrls

Return a list of saved searches using a list of ids.

• SavedSearchIds

Update the option that indicates that a saved search was sent or not.

• SavedSearchIds

Update the option that indicates if a saved search can be seing by a client or not.

• SavedSearchIds

Return the saved searches of an agent, this not include the client saved searches.

• UserId

Return the count of how many saved searches the agent and clients have.

• UserId

Return the count of how many saved searches the agent and clients have.

• UserId

Return the count of how many saved searches at client have

• UserId

Return the count of how many saved searches the client have.

• ClientId

Return a list of Saved Searches for a single client.

• ClientId

Return a list of the clients saved searches using a User Id.

• UserId

Created a Saved Search.

• SearchId
• UserId
• ClientId
• SearchName
• SearchParameters
• SendEmailUpdate
• IsEmailSent
• DateCreated
• DateLastChanged
• DateLastViewed
• ScheduledForAction
• ShowToClient

Update a existing Saved Search.

• SearchId
• UserId
• ClientId
• SearchName
• SearchParameters
• SendEmailUpdate
• IsEmailSent
• DateCreated
• DateLastChanged
• DateLastViewed
• ScheduledForAction
• ShowToClient

Delete Saved Searches by using the provided S. S. Ids

• ssId

Delete all the saved search of a client

• ClientId

Update the last time that saved search presented to a user.

• SavedSearchId

Brand Search

No documentation available.

Builder Search

Builder Search

Community Search

Community Search

Community Search

Community Search

DUDA Community Search

DUDA Community Search

Community Location Search

Community Location Search

Get Videos.

• PartnerId
• CommId

Get All Community and Listings counts by Partner Id.

• PartnerId

No documentation available.

No documentation available.

Home Search

Home Search

Home Search

Home Search

Home Locations Search

Home Locations Search

DUDA Home Search

DUDA Home Search

Return Favorites per site.

Return Favorites per site.

No documentation available.

No documentation available.

Recommendations
Search Parameters  More details here

Recommendations
Search Parameters  More details here

Get Typeahead Locations for the Partner using a Search term and optionally Location Types to filter

• PartnerId
• SearchTerm
• Types

MongoLocations

(An Action that handles HTTP GET requests) elastic search locations.

Returns a location based on a IP Address

Returns a location based on a IP Address

Get Recomended Communities, returns communities based on user's favorites (a.k.a People who liked this community also liked these other communities)

• PartnerId
• CommId
• sourceAction
• targetAction
• MaxResults

Get Recomended Listings, returns homes based on user's favorites (a.k.a People who liked this plan/spec also liked these other listings)

• PartnerId
• PlanId Or SpecId
• sourceAction
• targetAction
• MaxResults

Get Bookmark(s) by User Id (GUID), or by Logon Name and Partner Id.

• UserId Or LogonName
• PartnerId (Required when using LogonName)
• ActionName
• ContentId Or ContentTypeName
• showNotes
• showSharedUsers

Get an user Bookmark by it's Id

• BookmarkId
• showNotes
• showSharedUsers

Creates a new User Bookmark and optionally it can set its Bookmark Notes as well

• UserId
• ContentTypeId Or ContentTypeName
• ContentId
• Title
• Url
• Action
• Optionally the Notes array

Updates an User Bookmark and optionally it can set its Bookmark Notes as well

• Id
• UserId
• ContentId Or ContentTypeName
• ContentId : Long
• Title
• Url
• Action
• Optionally the Notes array

Delete Bookmark

• bookmarkId

Get Bookmark Content Types

Share a particular Bookmark with other user Http Delete Verb, remove the share bookmarks If only the bookmarkId is provided, all the bookmarks shared with that ID are going to be deleted

Share a particular Bookmark with other user Http Delete Verb, remove the share bookmarks If only the bookmarkId is provided, all the bookmarks shared with that ID are going to be deleted

Share a particular Bookmark with other user Http Delete Verb, remove the share bookmarks If only the bookmarkId is provided, all the bookmarks shared with that ID are going to be deleted

Get Bookmark Data by User Id (GUID), and optionally by Template Id and/or Bookmark Id.

• UserId
• TemplateId
• BookmarkId
• ShowNotes

Creates a new Bookmark Data, and returns the new Bookmark Data Id

• BookmarkId
• UserContent
• TemplateId
• BookmarkId
• Notes

Creates a new Bookmark Data, and returns the new Bookmark Data Id

• BookmarkId
• UserContent
• TemplateId
• BookmarkId
• Notes

Deletes Bookmark Data If bookmarkDataId is not provided the userId and contentId is required.

• bookmarkDataId
• userId
• contentId

Get Bookmark Notes

• bookmarkId

Set Bookmark Notes

• BookmarkId
• BookmarkNotes

Get Bookmark Data Notes

• bookmarkDataId

Get Bookmark Data Notes

• BookmarkDataId
• Notes

Get User Profile(s) by User Id (GUID), or by Logon Name and optionally Partner Id.

• UserId Or LogonName
• PartnerId (Available when using LogonName)

Creates a new User if the provided User Id or Logon Name and Partner Id don't exist in the DB, otherwise it returns false.

• UserId (GUID)
• LogonName
• PartnerId
• FirstName
• LastName
• MiddleName
• City
• State (Abbr)
• PostalCode (ZIP)
• RegMetro
• Password

Updates a User if the provided User Id or Logon Name and Partner Id exist in the DB. If the user doesn't exist, it returns false.

• UserId Or LogonName
• PartnerId (Required when using LogonName)
• FirstName
• LastName
• MiddleName (Char)
• City
• State (Abbr)
• PostalCode (ZIP)
• RegMetro
• Password

Inactivates an User Record if it exists in the DB

• UserId Or LogonName
• PartnerId

Deletes Test User Profiles.

• LogonName

Authenticates an User Account by using either the User Id or the Logon Name and Partner Id, plus the User Token to validate the password

• UserId Or LogonName
• PartnerId (Required when using LogonName)
• UserToken
• maxLoginAttempts

Lock User Account by User Id (GUID), or by Logon Name and Partner Id.

• UserId Or LogonName
• PartnerId (Required when using LogonName)

Unlock User Account by User Id (GUID), or by Logon Name and Partner Id.

• UserId Or LogonName
• PartnerId (Required when using LogonName)
• resetFailureCount

Get user information form Bookmark id

• BookmarkId

This endpoint returns the user model data of an user with specific email

Get Shared User Profile Status

• userId

Links two User Profiles

• SourceUserId
• DestUserEmail
• DestUserId

Updates Linked User Profile Status

• userId
• destUserEmail
• status
• destUserId

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.