GET
/
{apiVersion}
/
{apiProvince}
/
listing
curl --request GET \
  --url https://api.getbuildify.com/{apiVersion}/{apiProvince}/listing \
  --header 'x-api-key: <api-key>'
"{\n  \"builders\": [\n    {\n      \"summary\": \"Over the decades the building landscape has gone through incredible changes in which Greenpark has not only sustained, but often times shaped and led. Through all this growth the Greenpark legacy has continued to thrive securely resting upon the foundations which were built over 55 years ago.\",\n      \"address\": \"8700 Dufferin Street\\nVaughan, ON L4K 4S6\",\n      \"listings\": [\n        \"Listings/7I8F7Y\",\n        \"Listings/GFCFQD\",\n        \"Listings/RV8YIQ\",\n        \"Listings/41A42E\",\n        \"Listings/KWMHW0\",\n        \"Listings/JLON36\",\n        \"Listings/3ICZ3G\",\n        \"Listings/QTSL9E\",\n        \"Listings/4KQTX3\",\n        \"Listings/0GYBON\",\n        \"Listings/QGA7ZQ\",\n        \"Listings/Q1UD4Y\"\n      ],\n      \"website\": \"greenparkgroup.ca\",\n      \"name\": \"Greenpark Group\",\n      \"logo\": \"https://storage.googleapis.com/precon-app.appspot.com/bfd06b4f-d537-47c9-9799-ab814d065725.png\",\n      \"id\": \"3tLqusTBLjz2p52xbuU3\",\n      \"path\": \"Builders/3tLqusTBLjz2p52xbuU3\",\n      \"collection\": \"Builders\"\n    }\n  ],\n  \"name\": \"Sample Listing - TEST Example\",\n  \"summary\": \"This is the random summay\",\n  \"id\": \"Q1UD4Y\"\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

​
id
string
required

The specific id/objectId of the listing.

​
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.

Response

200
application/json

200

The response is of type object.

GET
/
{apiVersion}
/
{apiProvince}
/
listing
curl --request GET \
  --url https://api.getbuildify.com/{apiVersion}/{apiProvince}/listing \
  --header 'x-api-key: <api-key>'
"{\n  \"builders\": [\n    {\n      \"summary\": \"Over the decades the building landscape has gone through incredible changes in which Greenpark has not only sustained, but often times shaped and led. Through all this growth the Greenpark legacy has continued to thrive securely resting upon the foundations which were built over 55 years ago.\",\n      \"address\": \"8700 Dufferin Street\\nVaughan, ON L4K 4S6\",\n      \"listings\": [\n        \"Listings/7I8F7Y\",\n        \"Listings/GFCFQD\",\n        \"Listings/RV8YIQ\",\n        \"Listings/41A42E\",\n        \"Listings/KWMHW0\",\n        \"Listings/JLON36\",\n        \"Listings/3ICZ3G\",\n        \"Listings/QTSL9E\",\n        \"Listings/4KQTX3\",\n        \"Listings/0GYBON\",\n        \"Listings/QGA7ZQ\",\n        \"Listings/Q1UD4Y\"\n      ],\n      \"website\": \"greenparkgroup.ca\",\n      \"name\": \"Greenpark Group\",\n      \"logo\": \"https://storage.googleapis.com/precon-app.appspot.com/bfd06b4f-d537-47c9-9799-ab814d065725.png\",\n      \"id\": \"3tLqusTBLjz2p52xbuU3\",\n      \"path\": \"Builders/3tLqusTBLjz2p52xbuU3\",\n      \"collection\": \"Builders\"\n    }\n  ],\n  \"name\": \"Sample Listing - TEST Example\",\n  \"summary\": \"This is the random summay\",\n  \"id\": \"Q1UD4Y\"\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

​
id
string
required

The specific id/objectId of the listing.

​
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.

Response

200
application/json

200

The response is of type object.