Property

The Property resource is the primary way of interacting with Rela. You can create and update properties. Properties can be viewed as a list, and can be queried using fields.

The properties endpoint lists all property nids, titles, statuses and external ids for a given user id. This endpoint will return the total number of properties you have and 100 properties at a time.

By default, the properties are sorted in ascending order so the oldest created properties are first and the most recently created property is last. You may set the "order" query parameter to "DESC" to reverse the order of properties returned.

You may use the "page" query parameter to specify a page (of 100 properties) to get. For example, if you added /?page=3 to the request, you would receive the 300th-399th properties.

You may alternatively use the "offset" query parameter to specify which property to start at and 99 more (100 total). For example, if you wanted to grab 100 properties starting at the 345th property, you would add /?offset=345 to get properties 345-444.

Currently there is no way to change the limit (number of properties returned).

You may then use the property nid returned to query for that property's full details.

Last updated