MCP tool reference
Every tool the etg24 MCP server exposes, grouped by layer and domain. Meta-tools are advertised viatools/list; domain tools are discovered at runtime throughmeta.tools.search and invoked via meta.tool.execute. See the meta-tool workflow for how they fit together.
Catalogue generated at 2026-08-20T10:29:28+00:00.
Meta-tools8 tools
meta8 tools
meta.tools.searchmetaMeta-toolsSearch domain API tools (queries and commands) by natural-language query. Returns ranked tool definitions (name, description, inputSchema) that the caller is authorised to use. For the output schema, use meta.tool.describe on the matching tool names. Uses hybrid BM25 + embedding for English queries, embedding-only for other languages. Meta-tools (meta.tool.describe, thesaurus_*, etc.) are never returned. Call with an empty or omitted query to browse all available tools (paginated via limit/offset).
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
query | string | no | Natural-language search query. |
language | string | no | Language of the search query. English uses hybrid BM25+embedding; other languages use embedding-only to avoid noise from cross-lingual keyword mismatch. |
limit | integer | no | Maximum number of results. |
kind | string | no | Restrict results to queries or commands. |
offset | integer | no | Number of leading results to skip (pagination). |
meta.tool.describemetaMeta-toolsReturn the full input schema, output schema, and description for one or more tools by name. Use after meta.tools.search to inspect a tool's complete contract before executing it.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
toolNames | array<string> | yes | Names of the tools to describe. |
meta.tool.executemetaMeta-toolsExecute a single API endpoint tool by name with the given arguments. Optionally post-process the response with a JMESPath expression via _transform. This dispatcher is never annotated as destructive itself; before executing a write operation, call meta.tool.describe on the target tool and check its annotations.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | Name of the tool to execute. |
arguments | object | no | Arguments passed to the tool. |
_transform | string | no | Optional JMESPath expression applied to the response. |
meta.docs.searchmetaMeta-toolsSearch LLM-optimised endpoint documentation by natural-language query using BM25 ranking. Returns Markdown docs for the most relevant tools.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
query | string | no | Natural-language search query. |
limit | integer | no | Maximum number of results. |
meta.pipeline.executemetaMeta-toolsExecute a sequence of tool calls where later steps can reference results from earlier steps via JMESPath expressions. Enables cross-tool composition without custom code. This dispatcher is never annotated as destructive itself; inspect each step's tool with meta.tool.describe before running a pipeline that writes data.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
steps | array<object> | yes | Ordered pipeline steps. Each step has a "tool" name, optional "arguments", an optional "as" variable name, and an optional "transform" JMESPath expression. |
meta.thesaurus.searchmetaMeta-toolsSearch the bilingual (DE/EN) domain thesaurus for terms matching a query. Returns canonical terms, definitions, and synonyms projected into the requested language.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
query | string | no | Natural-language search query. |
domains | array<string> | no | Restrict results to these domain IDs. |
status | string | no | Which term pool to search. |
projection | string | no | Language projection for the results. |
limit | integer | no | Maximum number of results. |
meta.thesaurus.glossarymetaMeta-toolsReturn the full glossary of thesaurus entries for one or more domains, projected into the requested language.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
domains | array<string> | yes | Domain IDs to include. |
projection | string | no | Language projection for the results. |
meta.thesaurus.domainsmetaMeta-toolsList available thesaurus domains with descriptions and glossary size, so agents can estimate context-window cost before requesting a full glossary.
Platform API1 tools
versionqueryPlatform APIReturns version.
Endpoint
GET /api/platform/v1/query/versionProperty Management v276 tools
accounting17 tools
accounting.bankaccountinfos.create.contactcommandProperty Management v2Creates bank account info for contact.
Endpoint
POST /propertymanagement/v2/command/accounting.bankaccountinfos.create.contactScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
bankAccountInfo | object | yes | The bank account info to create for the contact. |
contact | string | yes | The contact to associate the bank account info with, referenced by ID or alias. |
accounting.bankaccountinfos.create.objectcommandProperty Management v2Creates bank account info for object.
Endpoint
POST /propertymanagement/v2/command/accounting.bankaccountinfos.create.objectScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
bankAccountInfo | object | yes | The bank account info to create for the object. |
object | string | yes | The object to associate the bank account info with, referenced by ID or alias. |
accounting.bankaccountinfos.updatecommandProperty Management v2Updates bank account info.
Endpoint
POST /propertymanagement/v2/command/accounting.bankaccountinfos.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
bankAccountInfo | object | yes | The bank account info to update, referenced by ID or alias with updated values. |
accounting.bankaccountuse.createcommandProperty Management v2Creates bank account use.
Endpoint
POST /propertymanagement/v2/command/accounting.bankaccountuse.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
bankAccountUse | object | yes | The bank account use to create. |
contract | string | yes | The contract to associate the bank account use with, referenced by ID or alias. |
accounting.bankaccountuse.updatecommandProperty Management v2Updates bank account use.
Endpoint
POST /propertymanagement/v2/command/accounting.bankaccountuse.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
bankAccountUse | object | yes | The bank account use to update, referenced by ID or alias with updated values. |
accounting.directdebitmandate.createcommandProperty Management v2Creates direct debit mandate.
Endpoint
POST /propertymanagement/v2/command/accounting.directdebitmandate.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
directDebitMandate | object | yes | The direct debit mandate to create. |
accounting.directdebitmandate.generatereferencecommandProperty Management v2Generates direct debit mandate reference.
Endpoint
POST /propertymanagement/v2/command/accounting.directdebitmandate.generatereferenceScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
directDebitMandate | string | yes | The direct debit mandate to generate a reference for, referenced by ID or alias. |
accounting.directdebitmandate.updatecommandProperty Management v2Updates direct debit mandate.
Endpoint
POST /propertymanagement/v2/command/accounting.directdebitmandate.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
directDebitMandate | object | yes | The direct debit mandate to update, referenced by ID or alias with updated values. |
accounting.bankaccountinfos.detailqueryProperty Management v2Shows bank account info.
Endpoint
GET /propertymanagement/v2/query/accounting.bankaccountinfos.detailScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
bankAccountInfo | string | yes | The bank account info to show, referenced by ID or alias. |
accounting.bankaccountinfos.listqueryProperty Management v2Lists bank account infos.
Endpoint
GET /propertymanagement/v2/query/accounting.bankaccountinfos.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
iban | string | no | Filter results to bank account infos with this IBAN. |
object | string | no | Filter results to bank account infos belonging to this object, referenced by ID or alias. |
contact | string | no | Filter results to bank account infos belonging to this contact, referenced by ID or alias. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
accounting.bankaccountuse.detailqueryProperty Management v2Shows bank account use.
Endpoint
GET /propertymanagement/v2/query/accounting.bankaccountuse.detailScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
bankAccountUse | string | yes | The bank account use to show, referenced by ID or alias. |
accounting.contract.bankaccountuse.fordatequeryProperty Management v2Returns valid bank account use.
Endpoint
GET /propertymanagement/v2/query/accounting.contract.bankaccountuse.fordateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
contract | string | yes | The contract to find a valid bank account use for, referenced by ID or alias. |
purpose | string | yes | The purpose for which the bank account use must be valid. |
validOn | string | yes | The date on which the bank account use must be valid. |
accounting.directdebitmandate.detailqueryProperty Management v2Shows direct debit mandate.
Endpoint
GET /propertymanagement/v2/query/accounting.directdebitmandate.detailScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
directDebitMandate | string | yes | The direct debit mandate to show, referenced by ID or alias. |
accounting.directdebitmandates.listqueryProperty Management v2Lists direct debit mandates.
Endpoint
GET /propertymanagement/v2/query/accounting.directdebitmandates.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
iban | string | no | Filter results to direct debit mandates with this IBAN. |
object | string | no | Filter results to direct debit mandates belonging to this object, referenced by ID or alias. |
contact | string | no | Filter results to direct debit mandates belonging to this contact, referenced by ID or alias. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
accounting.inboundinvoices.listqueryProperty Management v2Lists invoices.
Endpoint
GET /propertymanagement/v2/query/accounting.inboundinvoices.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
object | string | yes | The object to list invoices for, referenced by ID or alias. |
accounting.inboundinvoices.showqueryProperty Management v2Shows invoice details and accounting data.
Endpoint
GET /propertymanagement/v2/query/accounting.inboundinvoices.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
inboundInvoice | string | yes | The inbound invoice to show, referenced by ID or alias. |
accounting.object.bankaccountinfosqueryProperty Management v2Returns object account infos.
Endpoint
GET /propertymanagement/v2/query/accounting.object.bankaccountinfosScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
object | string | yes | The object to get bank account infos for, referenced by ID or alias. |
advisors3 tools
advisors.assigncommandProperty Management v2Assign an advisor to an object.
Endpoint
POST /propertymanagement/v2/command/advisors.assignScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
advisor | object | yes | The advisor to assign to an object. |
advisors.revokecommandProperty Management v2Revoke an advisor from an object.
Endpoint
POST /propertymanagement/v2/command/advisors.revokeScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
advisor | string | yes | The advisor to revoke, referenced by ID or alias. |
advisors.listqueryProperty Management v2List advisors for the current tenant with optional filters and pagination.
Endpoint
GET /propertymanagement/v2/query/advisors.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectId | string | no | Filter results to advisors assigned to this object. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
aliases3 tools
aliases.upsertcommandProperty Management v2Upserts a batch of aliases for the current (tenant, integration) scope. Each entry takes a bare `alias` (no `$` prefix), an `id` and an entity-`type`.
Endpoint
POST /propertymanagement/v2/command/aliases.upsertScopes
aliases.listqueryProperty Management v2Paginated listing of every alias stored for the current (tenant, integration) scope. Aliases on the wire are returned bare (no `$` prefix). Storage entries that point at an entity type unknown to the current {@see AliasTypeMap} are omitted from the response.
Endpoint
GET /propertymanagement/v2/query/aliases.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
aliases.resolvequeryProperty Management v2Bidirectional bulk-resolve of aliases and ids. Inputs are arrays of bare aliases AND/OR internal ids; outputs are tuples `{alias, id, type}` for every successful resolution. Aliases without a mapping and ids that do not have a mapping are simply omitted.
Endpoint
GET /propertymanagement/v2/query/aliases.resolveScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
aliases | array<string> | no | The aliases to resolve to internal ids. |
ids | array<string> | no | The internal ids to resolve to aliases. |
callrecords3 tools
callrecords.createcommandProperty Management v2Create a new call record.
Endpoint
POST /propertymanagement/v2/command/callrecords.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
callRecord | object | yes | The call record to create. |
callrecords.updatecommandProperty Management v2Update an existing call record.
Endpoint
POST /propertymanagement/v2/command/callrecords.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
callRecord | object | yes | The call record to update, referenced by ID or alias with updated values. |
callrecords.showqueryProperty Management v2Show a call record by id or alias.
Endpoint
GET /propertymanagement/v2/query/callrecords.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
callRecord | string | yes | The call record to show, referenced by ID or alias. |
contacts5 tools
contacts.createcommandProperty Management v2Create a new contact for the current tenant.
Endpoint
POST /propertymanagement/v2/command/contacts.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
contact | object | yes | The contact to create. |
contacts.mergecommandProperty Management v2Merge one or more source contacts into a target contact. Both payloads are Reference-only (id or alias required; no property fields). Returns 200 on success.
Endpoint
POST /propertymanagement/v2/command/contacts.mergeScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
sourceContact | string | yes | The source contact to merge into the target, referenced by ID or alias. |
targetContact | string | yes | The target contact that absorbs the source, referenced by ID or alias. |
contacts.updatecommandProperty Management v2Update an existing contact identified by its payload id or alias.
Endpoint
POST /propertymanagement/v2/command/contacts.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
contact | object | yes | The contact to update, referenced by ID or alias with updated values. |
contactsqueryProperty Management v2List contacts for the current tenant with optional filters and pagination.
Endpoint
GET /propertymanagement/v2/query/contactsScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
companyId | string | no | Filter results to contacts belonging to this company. |
personType | string | no | Filter results to contacts with this person type. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
contacts.showqueryProperty Management v2Show a single contact by id or alias.
Endpoint
GET /propertymanagement/v2/query/contacts.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
contact | string | yes | The contact to show, referenced by ID or alias. |
contracts4 tools
contracts.createcommandProperty Management v2Create a new contract for a unit.
Endpoint
POST /propertymanagement/v2/command/contracts.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
contract | object | yes | The contract data to create. |
contracts.updatecommandProperty Management v2Update an existing contract.
Endpoint
POST /propertymanagement/v2/command/contracts.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
contract | object | yes | The contract to update, referenced by ID or alias. |
contractsqueryProperty Management v2List contracts for the current tenant with optional filters and pagination.
Endpoint
GET /propertymanagement/v2/query/contractsScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectId | string | no | Filter results to contracts belonging to this object. |
unitId | string | no | Filter results to contracts belonging to this unit. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
contracts.showqueryProperty Management v2Show a single contract by id or alias.
Endpoint
GET /propertymanagement/v2/query/contracts.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
contract | string | yes | The contract to show, referenced by ID or alias. |
documents5 tools
documents.updatecommandProperty Management v2Update an existing document.
Endpoint
POST /propertymanagement/v2/command/documents.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
document | object | yes | The document to update, referenced by ID or alias. |
documents.uploadcommandProperty Management v2Upload a document to a location. Supports objects, contracts, units, object groups, processes, and process updates.
Endpoint
POST /propertymanagement/v2/command/documents.uploadScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
locationId | string | yes | The location to upload the document to. |
resource | object | yes | The uploaded file resource to process. |
document | object | no | The document metadata for the upload. |
documents.listqueryProperty Management v2List documents with optional filters and pagination.
Endpoint
GET /propertymanagement/v2/query/documents.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
locationId | string | no | Filter results to documents at this location. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
documents.showqueryProperty Management v2Show a document by id or alias.
Endpoint
GET /propertymanagement/v2/query/documents.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
document | string | yes | The document to show, referenced by ID or alias. |
documents.typemappingsqueryProperty Management v2Lists type to category mappings.
Endpoint
GET /propertymanagement/v2/query/documents.typemappingsScopes
info1 tools
infoqueryProperty Management v2Returns tenant and integration information.
Endpoint
GET /propertymanagement/v2/query/infoScopes
objectaddresses4 tools
objectaddresses.createcommandProperty Management v2Create a new object address.
Endpoint
POST /propertymanagement/v2/command/objectaddresses.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectAddress | object | yes | The object address data to create. |
objectaddresses.updatecommandProperty Management v2Update an existing object address.
Endpoint
POST /propertymanagement/v2/command/objectaddresses.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectAddress | object | yes | The object address to update, referenced by ID or alias. |
objectaddresses.listqueryProperty Management v2List object addresses for the current tenant, optionally filtered by object.
Endpoint
GET /propertymanagement/v2/query/objectaddresses.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectId | string | no | Filter results to the addresses of this object, referenced by its id. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
objectaddresses.showqueryProperty Management v2Show an object address by id or alias.
Endpoint
GET /propertymanagement/v2/query/objectaddresses.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectAddress | string | yes | The object address to show, referenced by ID or alias. |
objectgroups3 tools
objectgroups.createcommandProperty Management v2Create a new object group.
Endpoint
POST /propertymanagement/v2/command/objectgroups.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectGroup | object | yes | The object group data to create. |
objectgroups.updatecommandProperty Management v2Update an existing object group.
Endpoint
POST /propertymanagement/v2/command/objectgroups.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectGroup | object | yes | The object group to update, referenced by ID or alias. |
objectgroups.showqueryProperty Management v2Show an object group by id or alias.
Endpoint
GET /propertymanagement/v2/query/objectgroups.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectGroup | string | yes | The object group to show, referenced by ID or alias. |
objects4 tools
objects.createcommandProperty Management v2Create a new property object for the current tenant.
Endpoint
POST /propertymanagement/v2/command/objects.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
object | object | yes | The object data to create. |
objects.updatecommandProperty Management v2Update an existing property object.
Endpoint
POST /propertymanagement/v2/command/objects.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
object | object | yes | The object to update, referenced by ID or alias. |
objectsqueryProperty Management v2Lists all property objects for the tenant.
Endpoint
GET /propertymanagement/v2/query/objectsScopes
objects.showqueryProperty Management v2Show a single property object by id or alias.
Endpoint
GET /propertymanagement/v2/query/objects.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
object | string | yes | The object to show, referenced by ID or alias. |
openapi1 tools
openapi.specqueryProperty Management v2Returns the auto-generated OpenAPI 3.0 spec filtered to endpoints the requesting integration can access.
Endpoint
GET /propertymanagement/v2/query/openapi.specScopes
posts1 tools
posts.showqueryProperty Management v2Show a post by id or alias.
Endpoint
GET /propertymanagement/v2/query/posts.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
post | string | yes | The post to show, referenced by ID or alias. |
processes8 tools
processes.createcommandProperty Management v2Create a new process under the current property management tenant. Requires a process payload in Create mode (properties without an id) and an object reference that locates the owning property object.
Endpoint
POST /propertymanagement/v2/command/processes.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
process | object | yes | The process data to create. |
object | string | yes | The object the process belongs to, referenced by ID or alias. |
processes.updatecommandProperty Management v2Update an existing process identified by its payload id or alias. The process payload must be in Update mode (id or alias required, plus at least one property field to change).
Endpoint
POST /propertymanagement/v2/command/processes.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
process | object | yes | The process to update, referenced by ID or alias. |
processes.updates.createcommandProperty Management v2Create a process update.
Endpoint
POST /propertymanagement/v2/command/processes.updates.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
update | object | yes | The process update data to create. |
process | string | yes | The process to add the update to, referenced by ID or alias. |
processes.updates.updatecommandProperty Management v2Update an existing process update identified by its payload id. The process update payload must be in Update mode (id required, plus at least one property field to change).
Endpoint
POST /propertymanagement/v2/command/processes.updates.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
update | object | yes | The process update to update, referenced by ID. |
processes.listqueryProperty Management v2List processes for the current tenant with pagination. Supports filtering by archive status, associated object, and contract.
Endpoint
GET /propertymanagement/v2/query/processes.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
isArchived | boolean | no | Filter results to archived or active processes. |
object | string | no | The object to filter processes by, referenced by ID or alias. |
contract | string | no | Filter results to processes linked to this contract. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
processes.showqueryProperty Management v2Show a single process by id or alias.
Endpoint
GET /propertymanagement/v2/query/processes.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
process | string | yes | The process to show, referenced by ID or alias. |
processes.updates.listqueryProperty Management v2List process updates of a process with pagination.
Endpoint
GET /propertymanagement/v2/query/processes.updates.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
process | string | yes | The process to list updates for, referenced by ID or alias. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
processes.updates.showqueryProperty Management v2Show a single process update by id.
Endpoint
GET /propertymanagement/v2/query/processes.updates.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
update | string | yes | The process update to show, referenced by ID. |
responsibilities3 tools
responsibilities.createcommandProperty Management v2Create a responsibility linking a contact to an object with a job category.
Endpoint
POST /propertymanagement/v2/command/responsibilities.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
responsibility | object | yes | The responsibility data to create. |
contact | string | yes | The contact to link the responsibility to, referenced by ID or alias. |
object | string | yes | The object to link the responsibility to, referenced by ID or alias. |
responsibilities.updatecommandProperty Management v2Update an existing responsibility identified by its payload id or alias.
Endpoint
POST /propertymanagement/v2/command/responsibilities.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
responsibility | object | yes | The responsibility to update, referenced by ID or alias. |
responsibilities.listqueryProperty Management v2List responsibilities for the current tenant with optional filters.
Endpoint
GET /propertymanagement/v2/query/responsibilities.listScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
contactId | string | no | Filter results to responsibilities for this contact. |
objectId | string | no | Filter results to responsibilities for this object. |
categoryId | string | no | Filter results to responsibilities with this job category. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
signatories3 tools
signatories.createcommandProperty Management v2Create a new signatory.
Endpoint
POST /propertymanagement/v2/command/signatories.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
signatory | object | yes | The signatory data to create. |
signatories.updatecommandProperty Management v2Update an existing signatory.
Endpoint
POST /propertymanagement/v2/command/signatories.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
signatory | object | yes | The signatory to update, referenced by ID or alias. |
signatories.showqueryProperty Management v2Show a signatory by id or alias.
Endpoint
GET /propertymanagement/v2/query/signatories.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
signatory | string | yes | The signatory to show, referenced by ID or alias. |
status1 tools
statusqueryProperty Management v2Returns status.
Endpoint
GET /propertymanagement/v2/query/statusScopes
tenant1 tools
tenantqueryProperty Management v2Returns the current tenant's data.
Endpoint
GET /propertymanagement/v2/query/tenantScopes
unitgroups1 tools
unitgroups.listforobjectqueryProperty Management v2Lists unit groups.
Endpoint
GET /propertymanagement/v2/query/unitgroups.listforobjectScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
object | string | yes | The object to list unit groups for, referenced by ID or alias. |
units4 tools
units.createcommandProperty Management v2Create a new unit.
Endpoint
POST /propertymanagement/v2/command/units.createScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
unit | object | yes | The unit data to create. |
units.updatecommandProperty Management v2Update an existing unit.
Endpoint
POST /propertymanagement/v2/command/units.updateScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
unit | object | yes | The unit to update, referenced by ID or alias. |
unitsqueryProperty Management v2List units for the current tenant with optional filters and pagination.
Endpoint
GET /propertymanagement/v2/query/unitsScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
objectId | string | no | Filter results to units belonging to this object. |
limit | integer | yes | Maximum number of results to return (1-1000). |
offset | integer | yes | Number of results to skip for pagination. |
units.showqueryProperty Management v2Show a unit by id or alias.
Endpoint
GET /propertymanagement/v2/query/units.showScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
unit | string | yes | The unit to show, referenced by ID or alias. |
uvi1 tools
uvi.uploadcommandProperty Management v2Upload a UVI document for an object.
Endpoint
POST /propertymanagement/v2/command/uvi.uploadScopes
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
data | object | yes | The UVI upload data including object and category references. |
resource | object | yes | The uploaded file resource to process. |