Search Profiles

get

https://api.getbuildify.com/{apiVersion}/{apiProvince}/search_profiles

🔎 Search for profile details.

Path Params

apiVersion

string

enum

required

Allowed:

apiProvince

string

enum

required

Defaults to on

Query Params

collection

string

enum

required

Collection name of the profile to search from. See more info .

Allowed:

string

The given search string is searched from listing's name, summary, amenities, cityOrDistrict, streetName, country, neighbourhood. See more info.

page

int32

Fetch the given page of the results, starts from 0. See more info.

perPage

int32

Number of results per page.

facets

string

Facets to fetch, possible values can be amenities, builders, marketers, etc. It should be comma separated. See more info.

filterQuery

string

Query to filter the listings. See more info.

retrieveAttributes

string

Attributes to retrieve. For example: name, summary, builders, etc. It should be comma separated. See more info.

referrences

string

Fields to attach referrences. For example: builders, marketers, etc. It should be comma separated. See more info.

sortBy

string

Defaults to name

Sort by name

sortOrder

string

asc for ascending, dsc for descending

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

403403

404404

500500