Property management

Get a property

GET /api/v1/properties/PR-0031

One property by its code.

You need an institution key with the property:read scope. Your administrator makes one in Settings › API access.

Parameters

id

string · required

In the path. The property code, such as PR-0031.

Sample data only; nothing is sent. Have a key? Sign in to try it on real data.

401 invalid_key

The key is missing, unknown, revoked or expired.

403 ip_not_allowed

The request came from an address the key is not allowed to use.

429 rate_limited

Too many requests this minute. Wait for Retry-After seconds.

429 quota_exceeded

The monthly allowance is used up. It resets on the first of the month.

403 wrong_key

This is a comparables key. Use an institution key for this endpoint.

403 api_not_enabled

API access isn’t switched on for your institution.

403 not_in_plan

This API isn’t part of your institution’s plan. Ask ValueApps to add it.

403 insufficient_scope

The key doesn’t have the access this call needs.

404 not_found

No property has that id in your institution.