Actions103
- Calendar Actions
- Common Data Actions
- Contacts Actions
- Contracts Actions
- Credit Notes Actions
- Customers Actions
- Custom Fields Actions
- Estimates Actions
- Expenses Actions
- Invoices Actions
- Items Actions
- API Keys Actions
- Leads Actions
- Milestones Actions
- Payments Actions
- Projects Actions
- Property Actions
- Proposals Actions
- Staff Actions
- Subscriptions Actions
- Tasks Actions
- Tickets Actions
- Timesheets Actions
Property → Search
AI-generatedSummary
Search properties by a keyword term using the BackOffice ERP API and return matching property records.
Inputs
- Term (required) — The search keyword used to find matching properties (path parameter).
Output shape
a list of matching property records in JSON format, or details about multiple matches if the search is ambiguous
The operation performs a case-insensitive search; if multiple matches are found, it returns an object indicating multiple matches along with suggestions. If exactly one match is found, it returns the property details. Errors occur if the search term is invalid or no matches found. The matching is smart and supports names or IDs.