Skip to main content
POST
/realtorca/offices/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required
Required range: 1 <= x <= 600
timeout
integer
default:300
Required range: 20 <= x <= 1500
name
string | null
city
string | null
province
enum<string> | null
Available options:
alberta,
british_columbia,
manitoba,
new_brunswick,
newfoundland_and_labrador,
northwest_territories,
nova_scotia,
nunavut,
ontario,
prince_edward_island,
quebec,
saskatchewan,
yukon
address
string | null
postal_code
string | null
sort
enum<string>
default:no_preference
Available options:
no_preference,
name_asc,
name_desc,
city_asc,
city_desc,
province_asc,
province_desc

Response

Successful Response

id
string
required
@type
string
default:RealtorcaOfficeCard
name
string | null
designation
string | null
address
string | null
profile_url
string | null
image
string | null
phones
string[]
websites
string[]