Technical Guide
Typical journey for using the API to return information on properties within your group.
1. Review the Documentation
You find an endpoint /properties
that retrieves a list of all properties in your group.
2. Authentication
The API requires an API key and a unique trace token:
3. Identify the Endpoint
Endpoint: /properties
Method: GET
Parameters: page
, perPage
4. Make the API Call
5. Handle the Response
6. Handle Errors
If the API key is invalid, you might receive a 401 Unauthorized
response:
7. Implement Pagination
To fetch the next page of results, update the page
parameter:
Last updated
Was this helpful?