Skip to content
Last updated

Access

Refer to the API Reference for full attribute and endpoint details. The exact set of entities depends on what you want to show.

Structures and spaces

EntityAccessPurpose
organization.companyreadInvoicing company, landlord, owner.
objects.communityreadCommunity-level information.
objects.realestatereadFiltering; name, area metrics.
objects.buildingreadBuildings.
common.addressreadAddresses.
objects.apartmentreadRentable/ownable spaces.
objects.industrialpremisesreadRentable/ownable spaces.
objects.parkingspotreadRentable/ownable spaces.
objects.brfapartmentreadBRF apartments.
objects.outdoorsectionreadOutdoor sections.
objects.commonareareadCommon areas (optional).

Contracts

EntityAccessPurpose
contracts.apartmentcontractreadRentable contract for apartments.
contracts.industrialpremisescontractreadRentable contract for industrial premises.
contracts.parkingspotcontractreadRentable contract for parking spots.
contracts.outdoorsectioncontractreadRentable contract for outdoor sections.
contracts.othercontractreadOther contract types.
contracts.blockcontractreadBlock-level contract.
contracts.signedcontractdocumentreadDocuments signed outside Pigello and imported.
documents.signabledocumentreadDocuments signed in Pigello (often ZIP with PDF and metadata).

Users and communication

EntityAccessPurpose
accounts.tenantreadTenant identity and details.
accounts.subtenantreadSub-tenant identity and details.
communication.notificationreadNotifications sent to users.
communication.sendoutreadSendouts that can trigger notifications.

Invoices

EntityAccessPurpose
organization.companyreadInvoicing company, landlord, owner.
accounting.invoicereadInvoices.
accounting.invoicerowreadInvoice line items.
accounting.debtinvoicereadDebt invoices.
accounting.invoicepaymentreadPayments (distributed, matched, overpaid, unhandled).
accounting.invoicerecipientreadRecipients of invoices.
accounting.invoicerelatedpdffilereadInvoice PDFs.

Errands — General

EntityAccessPurpose
errands.generalerrandtypereadErrand type (e.g. fault report).
errands.generalerrandsubtypereadErrand sub-type.
errands.generalerrandreadThe errand.
errands.generalerrandfilereadFiles from the reporter.
errands.generalerrandactionreadActions on the errand.
errands.generalerrandactionfilereadFiles on actions.
errands.customerrandfieldtypereadCustom field definitions.
errands.customerrandfieldvaluereadCustom field answers.
errands.customerrandfieldinclusionreadWhich custom fields apply to a type.

Errands — Inspection

EntityAccessPurpose
errands.inspectionerrandsettingreadInspection type.
errands.inspectionerrandchecklistreadChecklist (may include custom fields).
errands.inspectionerrandreadThe inspection.
errands.tenantinspectionassociationreadTenant linked to inspection.
errands.inspectionerrandnotereadNotes during inspection.
errands.inspectionerrandfaultreadFaults during inspection.
errands.inspectionerrandfilereadFiles on notes/faults.