Skip to main content
GET
/
{apiVersion}
/
{apiProvince}
/
profile
Get A Profile
curl --request GET \
  --url https://api.getbuildify.com/{apiVersion}/{apiProvince}/profile \
  --header 'x-api-key: <api-key>'
{
  "address": "317 Adelaide St W, Toronto, Ontario, M5V 1P9, Canada",
  "listings": [
    "Listings/Q2TAED"
  ],
  "logo": "https://storage.googleapis.com/precon-app.appspot.com/3d16b6f7-c5ce-428e-87bd-651cc09d6ecd.png",
  "name": "Niche Development",
  "website": "nichedevelopment.ca",
  "path": "Builders/06K1RDAiqm543AVo72BE",
  "sample": "saath.bas@gmail.com",
  "id": "06K1RDAiqm543AVo72BE"
}

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

Profile ID to fetch.

​
collection
enum<string>
required

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

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

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

Response

200

​
address
string
Example:

"317 Adelaide St W, Toronto, Ontario, M5V 1P9, Canada"

​
listings
string[]
Example:

"https://storage.googleapis.com/precon-app.appspot.com/3d16b6f7-c5ce-428e-87bd-651cc09d6ecd.png"

​
name
string
Example:

"Niche Development"

​
website
string
Example:

"nichedevelopment.ca"

​
path
string
Example:

"Builders/06K1RDAiqm543AVo72BE"

​
sample
string
Example:

"saath.bas@gmail.com"

​
id
string
Example:

"06K1RDAiqm543AVo72BE"