Skip to main content
GET
/
{apiVersion}
/
{apiProvince}
/
search_profiles
Search Profiles
curl --request GET \
  --url https://api.getbuildify.com/{apiVersion}/{apiProvince}/search_profiles \
  --header 'x-api-key: <api-key>'
import requests

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

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.getbuildify.com/{apiVersion}/{apiProvince}/search_profiles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getbuildify.com/{apiVersion}/{apiProvince}/search_profiles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.getbuildify.com/{apiVersion}/{apiProvince}/search_profiles")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.getbuildify.com/{apiVersion}/{apiProvince}/search_profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
"{\n    \"results\": [\n      {\n        \"address\": \"45 Saint Clair Avenue West, 1001, Toronto, Ontario, M4V 1K9, Canada\",\n        \"listings\": [],\n        \"logo\": \"https://storage.googleapis.com/precon-app.appspot.com/d2d7751a-f463-44b3-8cc4-02ed7fcef6e2.png\",\n        \"name\": \"Knightstone Capital Management Inc.\",\n        \"website\": \"http://www.k-cap.com/\",\n        \"path\": \"Builders/zlVMmcdJv3yv3e3VZam3\",\n        \"objectID\": \"zlVMmcdJv3yv3e3VZam3\"\n      },\n      {\n        \"address\": \"3389 Steeles Avenue East, 100, Toronto, Ontario, M2H 0A1, Canada\\n\\n\",\n        \"listings\": [],\n        \"logo\": \"https://storage.googleapis.com/precon-app.appspot.com/f0a21e8c-ba53-4128-8dab-9e616353335c.png\",\n        \"name\": \"Kingdom Development\",\n        \"website\": \"https://kingdomcanada.com/\",\n        \"path\": \"Builders/zR9k4ao6zQgMJdxqs3Vf\",\n        \"objectID\": \"zR9k4ao6zQgMJdxqs3Vf\"\n      },\n      {\n        \"address\": \"29 Floral Parkway, Vaughan, Ontario, L4K 5C5, Canada\",\n        \"name\": \"Aspen Ridge Homes\",\n        \"listings\": [],\n        \"website\": \"www.aspenridgehomes.com/\",\n        \"logo\": \"https://storage.googleapis.com/precon-app.appspot.com/02d882d8-051f-4119-b7b1-d66c1b6216df.png\",\n        \"path\": \"Builders/zPMV1taAk2v7z561mZqi\",\n        \"objectID\": \"zPMV1taAk2v7z561mZqi\"\n      },\n      {\n        \"address\": \"1 Heathcote Avenue, Toronto, Ontario, M2L 1Y6, Canada\",\n        \"website\": \"http://inceptionbuilds.com/\",\n        \"listings\": [],\n        \"logo\": \"https://storage.googleapis.com/precon-app.appspot.com/08d65a01-48fc-40b6-a9a4-37ead001a665.png\",\n        \"name\": \"Inception Builds \",\n        \"path\": \"Builders/zORZmZicRKOI8s11GrAu\",\n        \"objectID\": \"zORZmZicRKOI8s11GrAu\"\n      },\n      {\n        \"address\": \"351 King Street East, Suite 1300, Toronto, Ontario, M5A 2W4, Canada\",\n        \"listings\": [\n          \"Listings/IIIVXP\",\n          \"Listings/GUSTT9\",\n          \"Listings/45O0O2\",\n          \"Listings/G3BN06\",\n          \"Listings/9HP9OH\",\n          \"Listings/4R79XO\",\n          \"Listings/74L784\",\n          \"Listings/A3TO2L\",\n          \"Listings/JL20MI\",\n          \"Listings/35Z84Z\",\n          \"Listings/1HX2HR\",\n          \"Listings/WQ82BZ\",\n          \"Listings/DYSHUW\",\n          \"Listings/LHMWX3\",\n          \"Listings/N7FI01\",\n          \"Listings/VTW6PH\",\n          \"Listings/IUOZ5M\",\n          \"Listings/3X6MSC\",\n          \"Listings/P7OFCL\",\n          \"Listings/7M27MZ\"\n        ],\n        \"logo\": \"https://storage.googleapis.com/precon-app.appspot.com/13d3ba02-6fc0-4c14-8633-d1117289fa96.png\",\n        \"name\": \"Great Gulf\",\n        \"website\": \"greatgulf.com\",\n        \"path\": \"Builders/zM9HpwU2VeYtShSVdXj4\",\n        \"summary\": \"Great Gulf began in 1975 with a belief that we weren’t just building homes but creating spaces. From our first lot in Cambridge, Great Gulf is the residential division of the Great Gulf Group of Companies; a multifaceted company which includes commercial, mixed-use, and residential development, construction management and software, engineered panel manufacturing, architecture, and hospitality, in 18 cities across North America. We’ve come a long way, but while a lot has changed in that time, one thing has not: our unwavering commitment to building spaces that inspire people to live greatly.\",\n        \"objectID\": \"zM9HpwU2VeYtShSVdXj4\"\n      }\n    ],\n    \"total\": 419,\n    \"page\": 0,\n    \"pages\": 84,\n    \"perPage\": 5\n  }"
"{\n    \"requestId\": \"1675936223634268992-YXdzLWFwLXNvdXRoLTE=-ac3f111584da4f489314e9c6c92790367256926c0f974c11977d1603291b8add\",\n    \"message\": \"Forbidden\"\n}"
"{\n  \"requestId\": \"1675932446423783452-YXdzLXVzLWVhc3QtMQ==-0f710a4f3134456ea1ca490d876f436da111ead72ec34fd48a2b4a2e5ed813fa\",\n  \"message\": \"No data product found. Please contact your data provider\"\n}"
"{\n  \"message\": \"Error 500\"\n}"

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
apiVersion
enum<string>
required
Available options:
v1-sandbox,
v1-lite,
v1
​
apiProvince
enum<string>
default:on
required
Available options:
all,
on,
bc,
ab,
mb,
nb,
nl,
ns,
pe,
qc,
sk

Query Parameters

​
collection
enum<string>
required

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

Available options:
,
Architects,
Builders,
InteriorDesigners,
Marketers,
SalesCentres,
SalesCompanies
​
search
string

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

​
page
integer<int32>

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

​
perPage
integer<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
default:name

Sort by name

​
sortOrder
string

asc for ascending, dsc for descending

Response

200

​
results
object[]
​
total
integer
default:0
Example:

419

​
page
integer
default:0
Example:

0

​
pages
integer
default:0
Example:

84

​
perPage
integer
default:0
Example:

5