Quickstart
- Sign in to Proppely and open Settings → Integrations → API keys.
- Choose Create key, name it after what will use it, tick the scopes it needs and pick when it expires (up to 365 days; 90 by default).
- Copy the key. It is shown once.
- Check that it works:
curl https://www.proppely.com/api/v1/developer/me \
-H "Authorization: Bearer $PROPPELY_API_KEY"The answer names the key, the scopes it holds right now, its expiry, you and your organization. If your role no longer allows a scope you ticked, it is listed under suspendedScopes instead.
Keys and scopes
Send the key as a bearer token on every request: Authorization: Bearer ppy_live_…. A key belongs to one person in one organization and acts as that person. Staff can create keys for themselves (Owner, Property Manager, Accountant, Leasing Agent, Maintenance). Resident, vendor and investor logins cannot.
A key can never do more than you can. On every call Proppely re-reads your role and cuts the key’s scopes down to what that role allows today. If you leave the organization or your account is suspended, the key stops working on its next call. Every owner in the organization is told whenever someone creates a key, and owners can see and revoke every key in Settings.
A scope is an area and a verb, such as maintenance:read. read runs reads, write runs ordinary changes, and propose lets the key ask for payments, sends and anything irreversible, which wait for a person to approve them. There is no approve scope. The restricted areas (banking, screening, tax and payroll) are never part of a preset: a key holds them only when you tick them yourself, and third-party apps won’t be able to ask for them.
Which roles may put each scope on a key: R read, W write, P propose, M manage.
| Area | Scopes | Owner | Property Manager | Accountant | Leasing Agent | Maintenance |
|---|---|---|---|---|---|---|
| Properties Properties, units, owners, assets, inspections and photos. |
| RWP | RWP | R | R | R |
| Leases Leases, renewals, notices, move-ins, abstracts and legal matters. |
| RWP | RWP | R | RWP | — |
| Residents Resident records, profiles, portal access and renters insurance. |
| RWP | RWP | R | RW | R |
| Applications Rental applications and decisions. No screening reports. |
| RWP | RWP | — | RWP | — |
| Marketing Listings, prospects, leads, showings and your brokerage site. |
| RWP | RWP | — | RWP | — |
| Maintenance Maintenance requests, work orders, vendor assignment and comments. |
| RWP | RWP | — | RW | RWP |
| Vendors Vendor records, invites and messages. Tax IDs are never returned. |
| RWP | RWP | RWP | — | R |
| Accounting Bills, charges, recorded payments, expenses, the ledger and budgets. |
| RWP | RWP | RWP | — | — |
| Reports Operational reports across your portfolio, saved and emailed reports. |
| RP | RP | RP | R | — |
| Documents Documents, templates and signature requests. |
| RWP | RWP | R | RWP | R |
| Communications Email threads, templates and announcements. Every send is a proposal. |
| RWP | RWP | — | RWP | — |
| Workspace Tasks, notes, the calendar, your team list and your own preferences. |
| RWP | RWP | RWP | RWP | RWP |
| Associations HOA and condo association records. |
| RP | RP | R | — | — |
| Event feed Poll the event feed. Each event still needs read access to its own area, such as Maintenance. |
| R | R | R | R | R |
| Webhooks Add, change and remove this key's own webhook endpoints. Events carry ids only, never money or messages. |
| M | M | M | M | M |
| BankingRestricted Bank connections, bank transactions and payment accounts. |
| RWP | RWP | RWP | — | — |
| ScreeningRestricted Screening status. Scores and reports are never returned. |
| RWP | RWP | — | — | — |
| Tax and payrollRestricted 1099s, W-2s and wage payments. |
| RWP | RWP | RWP | — | — |
| Admin Team, roles, org settings, integrations and agent access. | No key can hold this, whatever its holder’s role. | |||||
Calling tools
GET https://www.proppely.com/api/v1/developer/tools lists the tools your key can call, each with its JSON Schema, scope and whether it runs or proposes under your organization’s current approval setting. Call one by posting its arguments as a JSON object:
curl -X POST https://www.proppely.com/api/v1/developer/tools/lookup_maintenance \
-H "Authorization: Bearer $PROPPELY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"status": "OPEN", "priority": "EMERGENCY"}'Responses
200— it ranReads, and writes in an organization that lets writes run.
200 { "status": "ok", "result": { … }, "correlationId": "…" }202— proposed, nothing has runPayments, payouts, sends, anything irreversible, and writes when your organization requires approval for them. A person reviews the proposal in Proppely; payouts need two different people. Poll
GET /approvals/{approvalId}, or subscribe to theapproval.executedandapproval.rejectedevents.202 { "status": "proposed", "approvalId": "…", "risk": "irreversible", "expiresAt": "…", "reviewUrl": "https://www.proppely.com/approvals", "message": "Proposed. Nothing has run. A person must approve it in Proppely." }403— not allowedinsufficient_scopenames the scope to add inrequiredScope.role_not_permittedmeans the key has the scope but your current role no longer allows it.404—tool_not_available- No API key can call this tool, whatever its scopes. Admin tools are like this.
422— refused- The body was not a JSON object (
invalid_arguments), or the tool ran and reported why it could not finish (status: "failed"). 429— slow down- Too many requests, or too many proposals waiting on people. Wait for the
Retry-Afterheader. See rate limits. 401and402- The key is missing, unknown, revoked or expired, or its holder is no longer an active staff member (401). The organization’s membership is suspended (402).
Every request and response is in the OpenAPI 3.1 document, one operation per tool, with the tool’s own schema, for any tool that reads OpenAPI 3.1.
Webhooks
A webhook endpoint belongs to the key that created it. Add one with a key that holds webhooks:manage; it lives as long as that key does. Each event still needs read access to its own area, so a key with only maintenance:read never receives anything else. Endpoints are managed through the API for now.
curl -X POST https://www.proppely.com/api/v1/developer/webhook-endpoints \
-H "Authorization: Bearer $PROPPELY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com/proppely", "eventTypes": ["maintenance_request.created"]}'The response holds the signing secret (whsec_…) once. The URL must be HTTPS on port 443 at a public hostname; Proppely checks the address again before every delivery and follows no redirects. Every owner in the organization is told when an endpoint is added. A 503 webhooks_unavailable answer means webhook delivery is switched off for now; the event feed below works either way.
Verify every delivery
Each delivery carries Proppely-Webhook-Signature: t= is the Unix time it was signed and each v1= is a hex HMAC-SHA256 of {t}.{raw body} under your secret. Compute it over the raw body, before parsing, compare in constant time, and refuse timestamps more than 5 minutes off. After you rotate the secret, deliveries carry a signature from each secret for 1 day.
import crypto from 'node:crypto';
import express from 'express';
const SECRET = process.env.PROPPELY_WEBHOOK_SECRET; // the whole whsec_… string
const TOLERANCE_SECONDS = 300;
function verify(header, rawBody, secret) {
let t = null;
const signatures = [];
for (const part of (header ?? '').split(',')) {
const [key, value] = part.split('=', 2);
if (key === 't' && /^\d+$/.test(value ?? '')) t = Number(value);
else if (key === 'v1' && value) signatures.push(value);
}
if (t === null || Math.abs(Date.now() / 1000 - t) > TOLERANCE_SECONDS) return false;
const expected = crypto.createHmac('sha256', secret).update(`${t}.${rawBody}`).digest('hex');
return signatures.some(
(sig) =>
sig.length === expected.length &&
crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected)),
);
}
const app = express();
// Raw body: the signature covers the exact bytes Proppely sent.
app.post('/proppely', express.raw({ type: 'application/json' }), (req, res) => {
const rawBody = req.body.toString('utf8');
if (!verify(req.get('Proppely-Webhook-Signature'), rawBody, SECRET)) return res.status(400).end();
const event = JSON.parse(rawBody);
// At least once: skip event.id if you have handled it already.
console.log(event.type, event.data.object);
res.status(200).end();
});import hashlib
import hmac
import os
import time
SECRET = os.environ["PROPPELY_WEBHOOK_SECRET"] # the whole whsec_... string
TOLERANCE_SECONDS = 300
def verify(header, raw_body: bytes, secret: str = SECRET) -> bool:
t, signatures = None, []
for part in (header or "").split(","):
key, _, value = part.partition("=")
if key == "t" and value.isdigit():
t = int(value)
elif key == "v1" and value:
signatures.append(value)
if t is None or abs(time.time() - t) > TOLERANCE_SECONDS:
return False
expected = hmac.new(secret.encode(), f"{t}.".encode() + raw_body, hashlib.sha256).hexdigest()
return any(hmac.compare_digest(sig, expected) for sig in signatures)
# Flask:
# if not verify(request.headers.get("Proppely-Webhook-Signature"), request.get_data()):
# abort(400)Proppely-Event-Id: The event id. Delivery is at-least-once, so dedupe on this.Proppely-Event-Type: The event type, such as maintenance_request.created.Proppely-Delivery-Id: This delivery attempt. It appears in the delivery log.Proppely-Delivery-Attempt: Which attempt this is, starting at 1.
Retries
Answer with any 2xx within 10 seconds. Anything else is retried 8 times, after 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours, 1 day, 1 day. Delivery is at least once and not in order, so dedupe on Proppely-Event-Id. A 410 Gone disables the endpoint at once, and so do 3 days of continuous failure; you and the organization’s owners are told. The delivery log is at GET /webhook-endpoints/{id}/deliveries.
The event feed
With events:read, GET https://www.proppely.com/api/v1/developer/events returns the same events, filtered the same way. Page forward with after set to the last nextCursor. Use it to catch up after downtime or instead of webhooks. Events are kept for 30 days, and the newest 5 seconds are held back so a cursor never skips one.
Events
Payloads are thin on purpose: ids and a few fields, never names, messages, amounts or contact details. Fetch the rest through the API with your own key, which applies your scopes again.
maintenance_request.created
A maintenance request was submitted, on any channel.
Needs maintenance:read.
data.object object: "maintenance_request" · id string · propertyId string · unitId string, nullable · status SUBMITTED | REVIEWED | APPROVED | ASSIGNED | SCHEDULED | IN_PROGRESS | AWAITING_PARTS | AWAITING_VENDOR | AWAITING_TENANT | COMPLETED | CLOSED | CANCELLED · priority LOW | MEDIUM | HIGH | URGENT | EMERGENCY · category string · channel dashboard | resident_portal | assistant | voice | phone | inspection | text
maintenance_request.updated
A maintenance request's status or priority changed.
Needs maintenance:read.
data.object object: "maintenance_request" · id string · propertyId string · unitId string, nullable · fromStatus SUBMITTED | REVIEWED | APPROVED | ASSIGNED | SCHEDULED | IN_PROGRESS | AWAITING_PARTS | AWAITING_VENDOR | AWAITING_TENANT | COMPLETED | CLOSED | CANCELLED · toStatus SUBMITTED | REVIEWED | APPROVED | ASSIGNED | SCHEDULED | IN_PROGRESS | AWAITING_PARTS | AWAITING_VENDOR | AWAITING_TENANT | COMPLETED | CLOSED | CANCELLED · fromPriority LOW | MEDIUM | HIGH | URGENT | EMERGENCY · toPriority LOW | MEDIUM | HIGH | URGENT | EMERGENCY
maintenance_request.emergency
A maintenance request was marked an emergency, at creation or later.
Needs maintenance:read.
data.object object: "maintenance_request" · id string · propertyId string · unitId string, nullable · category string
work_order.assigned
A vendor or staff member was assigned. A work order shares its maintenance request id.
Needs maintenance:read.
data.object object: "work_order" · id string · propertyId string · unitId string, nullable · vendorId string, nullable · assignedToId string, nullable
work_order.scheduled
A visit time was set or moved.
Needs maintenance:read.
data.object object: "work_order" · id string · propertyId string · unitId string, nullable · scheduledFor timestamp · scheduledWindow string, nullable
work_order.completed
The work was marked complete. Costs are never included, only whether one was recorded.
Needs maintenance:read.
data.object object: "work_order" · id string · propertyId string · unitId string, nullable · completedAt timestamp · hasCost boolean
approval.proposed
An agent, API key or assistant proposed an action a person must approve in Proppely. Nothing has run.
Needs workspace:read, plus read on the area of the tool it names. Reaches owners, managers and accountants, who review approvals, and otherwise only the person the proposal was made for.
data.object object: "approval" · id string · toolName string · risk string · consumer string · proposedById string · expiresAt timestamp
approval.executed
A person approved a proposal and it ran. outcome says whether the action itself succeeded.
Needs workspace:read, plus read on the area of the tool it names. Reaches owners, managers and accountants, who review approvals, and otherwise only the person the proposal was made for.
data.object object: "approval" · id string · toolName string · risk string · consumer string · proposedById string · decidedById string · outcome succeeded | failed
approval.rejected
A person declined a proposal, or its proposer withdrew it. Nothing ran.
Needs workspace:read, plus read on the area of the tool it names. Reaches owners, managers and accountants, who review approvals, and otherwise only the person the proposal was made for.
data.object object: "approval" · id string · toolName string · risk string · consumer string · proposedById string · decidedById string
Rate limits
- 600 requests per 5 minutes per key.
- 20 proposals per key per hour. People have to read every one, so a key that floods the approvals queue is stopped.
- 2,000 requests per 15 minutes from one IP address, across all keys.
Over a limit you get 429 with a Retry-After header in seconds. Responses also carry RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset.
What you can’t do with the API
These limits are part of the product, not gaps waiting to be filled.
- No payment or payout runs from a key. Each one becomes a proposal that a person approves inside Proppely, and payouts need two different people. Residents pay rent only in the resident portal, never through the API.
- No key approves anything, its own proposals included. The approve and reject actions do not accept API keys.
- No full Social Security numbers, EINs, bank account numbers or card numbers. Tools return the last four digits at most, and card numbers never reach Proppely at all.
- No screening reports. Screening scopes return status only, never scores, reports or the reasons behind a decision.
- No admin. Keys cannot manage the team, roles, organization settings, integrations, approval rules or other keys. Those stay in the browser.
- No messages you write go out on their own. Emails, announcements, vendor messages and invites are proposals a person approves, and webhooks never send anything. A change your key makes still sets off Proppely’s standard notices, such as the work order a vendor receives when you assign them. Those go by text only to people who opted in to texts.
Publishing an app
Today you can build for yourself: a personal key automates your own organization under your own role, with no review. Don’t give your key to someone else’s product. Apps that other Proppely customers install are what an app store is for, and that is coming. It isn’t open yet, and we aren’t giving a date. The integrations Proppely builds itself are already listed in the app directory.
The plan is a trust ladder. Every app will show one label on its listing and on the screen where a customer allows it:
- Private. Installs only in the developer’s own organization and a few test organizations they invite.
- Reviewed. Passed Proppely’s review of its security, the scopes it asks for and why, how long it keeps data, and its copy. Owners and managers can install it.
- Verified publisher. Reviewed, and published by a registered company whose legal entity, domain and accountable officer have been checked. Only a registered company can earn it.
- Built by Proppely. Our own apps.
A badge says who is asking, not what they may ask for. No app, verified or not, will be able to request the restricted areas or admin, and no app will be able to approve a payment or payout. Badges can’t be bought, and a publisher can lose one.
Tool reference
Every tool a key can call, by area. Full descriptions and argument schemas are in the OpenAPI document. 32 more tools work only in the Proppely app and the assistant, because they are admin.
Properties26 tools
ai_match_photo_import_foldersreadUse the existing AI photo matcher to match folder names and filenames to organization-owned properties and units.
create_inspectionwriteSchedule an inspection (move-in, move-out, routine, or general).
create_photo_import_sessionwriteCreate a resumable bulk photo import session after reviewing folder/property matches.
create_propertywriteCreate a new property.
create_unitwriteAdd a unit to an existing property.
execute_photo_importwriteUpload matched photo batches into property, unit, or listing-backed galleries and advance a photo-import session.
force_delete_propertyproposesPermanently delete a property and every dependent record (units, leases, bills, expenses, documents, tasks, etc.).
get_photo_import_sessionreadRead a bulk photo import session and its progress for resume.
lookup_inspectionsreadLook up inspections for a property or unit.
lookup_propertyreadSearch the user's properties by name or address.
lookup_property_assetsreadRead appliances/service history, utilities, parking, meter readings, and sanitized access-credential inventory.
lookup_stakeholdersreadWho owns a property: rental owners / property owners and investors, ownership percent, portal access grants, owner financials, investor payment history.
lookup_unitreadGet units for a specific property.
manage_inspectionproposesUpdate/delete inspections, manage items/photos, create work orders, complete, or record a staff dispute.
manage_property_assetsproposesManage appliances, utilities, parking, meter readings, and access-credential inventory.
manage_stakeholdersproposesAdd or update a rental owner / property owner / investor — the person or company that owns a property; for the LLC that collects the rent use manage_payout_routing instead.
mark_unit_readywriteMark a unit that is being made ready (status MAKE_READY) as ready for move-in.
match_photo_import_foldersreadFuzzy-match bulk-import folder names to properties in this organization.
remove_gallery_photoproposesPermanently remove a gallery image, promote the next cover, and best-effort delete the S3 object.
reorder_gallery_photoswriteReorder all supplied image IDs within a property/unit/listing-backed gallery.
update_gallery_photowriteUpdate a property/unit/listing gallery image caption, order, type, or primary-cover state.
update_photo_import_sessionwriteUpdate a scoped photo-import session before execution.
update_propertywriteUpdate an existing property — name, description, type, year built, status, video URL, virtual tour URL — and its money setup: which business entity (LLC) owns it and collects its rent (connectedAcc…
update_unitwriteUpdate an existing unit — bedrooms, bathrooms, sqft, rent, status, notes, features.
upload_property_photoswriteUpload raw base64 photos to a property gallery.
upload_unit_photoswriteUpload one or more photos onto a unit's media gallery from raw image data (e.g.
Leases34 tools
add_lease_partyproposesAdd one more person to a lease that already exists: a roommate or second tenant moving in mid-lease, a co-applicant the original lease missed, or a cosigner or guarantor added later ("put Maria on…
amend_leaseproposesEdit the terms of an existing lease in place.
attach_signed_lease_pdfproposesAttach a completed signed PDF as a versioned lease document and optionally confirm selected terms.
cancel_renewal_offerproposesCancel a DRAFT or SENT renewal offer.
create_leaseproposesCreate a structured lease from explicit unit, tenant, term, rent, deposit, cadence, and commercial fields.
create_lease_from_pdfwriteCOMMIT a signed lease PDF: creates an ACTIVE lease with its rent escalations and billing artifacts, attaches the PDF, and flips the unit VACANT→OCCUPIED.
create_renewal_offerwriteCreate a DRAFT renewal offer for an ACTIVE lease.
delete_legal_recordproposesDelete a legal matter, step, evidence item, contact, or note.
extend_leaseproposesExtend an editable lease to a later end date without creating a renewal lease.
extract_lease_termswriteRead an already-imported lease's stored PDF and extract its terms.
give_lease_noticewriteRecord or update a notice to vacate.
lookup_leasereadGet full lease details including terms, tenants, rent, dates, documents, and signing status.
lookup_lease_abstractreadRead the stored or generated commercial lease abstract.
lookup_lease_escalationsreadList scheduled and applied rent escalations for a lease.
lookup_lease_late_fee_policyreadRead the lease-level late-fee policy.
lookup_lease_renewal_eligibilityreadCalculate current renewal eligibility for a lease.
lookup_legal_mattersreadList legal matters/deadlines/contacts or inspect the complete scoped matter pipeline.
lookup_renewal_offersreadList lease renewal offers with optional lease, property, or status filters.
lookup_renewal_rankingreadRank active leases by renewal worthiness.
manage_lease_escalationproposesCreate/generate, apply, or remove a lease rent escalation.
manage_legal_filingproposesRecord filing details or close/reopen a legal matter.
manage_legal_pipelinewriteCreate/edit legal matters and manage steps, deadlines, evidence, contacts, and notes without filing/closing/deleting.
move_in_tenantwriteMove a tenant into a unit — creates a lease, links the tenant, bills the first month (prorated when the start is mid-month) and the security deposit, and sets rent to recur monthly.
preview_lease_from_pdfwriteDRY RUN of a lease PDF import — writes nothing.
renew_leasewriteRenew an existing lease with optional rent increase.
send_lease_for_signingproposesEmail a DRAFT or PENDING lease to all its tenants for electronic signature.
send_renewal_for_signingproposesSend a lease-renewal offer to the tenants for e-signature using the built-in renewal ADDENDUM (extends the term; all other original-lease terms survive).
terminate_leaseproposesTerminate or early-terminate a lease through the canonical transaction, disabling future billing and optionally creating fees.
undo_lease_renewalproposesUndo a legacy renewal and delete its still-draft successor lease.
update_lease_statuswriteChange a lease status — activate, terminate, or mark as expired.
update_renewal_offerwriteUpdate terms on a DRAFT renewal offer.
upsert_lease_abstractwriteCreate or update the structured lease abstract fields.
upsert_lease_late_fee_policyproposesCreate or update a lease-level late-fee policy.
withdraw_lease_noticeproposesWithdraw a notice to vacate and cancel its auto-scheduled inspection.
Residents14 tools
add_tenant_profile_itemwriteAdd an emergency contact, pet, or vehicle to a tenant profile.
create_tenant_recordwriteCreate a typed tenant insurance, employment, or rental-history record.
get_tenant_contextreadFetch everything relevant about a specific tenant in one call: contact info, active lease + unit + property, open bills, recent payments, open maintenance requests on their unit, appliances in thei…
invite_tenantproposesEmail someone an invitation to the resident portal for a lease ("send John his portal invite", "invite jane@example.com to the lease for unit 4").
lookup_insurancereadCheck tenant renters insurance status.
lookup_tenantreadSearch tenants by name or email.
lookup_tenant_recordsreadList a tenant’s insurance, employment, or rental-history records.
manage_insuranceproposesCreate/update/verify/delete tenant insurance and compliance records.
manage_tenant_accesswriteUpdate a tenant contact profile or revoke tenant portal access.
remove_tenant_profile_itemproposesPermanently remove an emergency contact, pet, or vehicle from a tenant profile.
remove_tenant_recordproposesPermanently remove a tenant insurance, employment, or rental-history record.
update_tenant_profilewriteUpdate a tenant profile (birth date, forwarding address, communication preferences, or internal tenant comments).
update_tenant_profile_itemwriteUpdate an existing emergency contact, pet, or vehicle on a tenant profile.
update_tenant_recordwriteUpdate a tenant insurance, employment, or rental-history record.
Applications23 tools
add_application_notewriteAppend to the internal notes on an application (PM-only — applicant never sees these).
approve_applicationproposesApprove a rental application.
archive_applicationwriteHide an application from the active inbox (typically after a final outcome).
bulk_update_applicationswriteBulk archive, unarchive, or change application status for organization-owned application IDs.
convert_prospect_to_applicationwriteSkip the public apply form and create a stub RentalApplication for this prospect (for in-office walk-throughs / phone applications).
create_manual_applicationproposesCreate a manual/offline rental application (paper form, walk-in, phone call) using the existing configured fee defaults.
decline_applicationproposesDecline a rental application.
delete_applicationsproposesPermanently delete one or more applications and their dependent workflow rows.
invite_applicantproposesSend an external person a public apply-page link by email — used for walk-ins / phone leads who AREN'T yet in the prospects CRM.
lookup_application_configurationreadRead screening settings, applicant checklist/progress, and applicant groups.
lookup_application_statsreadRead active application counts by workflow status.
lookup_application_workspacereadRead application detail, document requests, and safe screening state.
lookup_applicationsreadLook up rental applications (prospect pipeline).
lookup_commercial_application_diligencereadCalculate the current commercial application diligence scorecard.
lookup_unit_application_pipelinereadRead the active applicant pipeline for one organization-owned unit.
manage_application_configurationproposesManage screening policy, checklist stages/items/progress, and applicant groups.
manage_application_document_requestproposesCreate, reopen, or cancel an applicant document request.
resend_application_messageproposesResend an applicant welcome or hosted screening email.
send_application_to_prospectproposesEmail this prospect a prefilled rental-application link to your public /apply page.
set_application_income_verificationproposesSet or clear the owner/manager manual income-verification override.
set_application_statuswriteMove a RentalApplication to PENDING / UNDER_REVIEW / WITHDRAWN.
unarchive_applicationwriteRestore an archived application.
update_applicationwriteCorrect editable applicant contact, income, move-in, unit/listing assignment, message, or internal-note fields.
Marketing21 tools
add_prospect_activitywriteLog an activity entry on a prospect: a phone-call note, email summary, showing notes, or a generic note.
archive_prospectwriteHide a prospect from the active inbox (LOST / CONVERTED leads).
assign_prospectwriteAssign a prospect to a teammate (OWNER / MANAGER / AGENT).
create_listingwriteCreate a rental or sale listing for a property/unit.
create_prospectwriteAdd a new prospect (lead) to the CRM.
delete_prospectproposesPermanently delete a prospect and its activity history.
draft_site_copyreadDraft marketing copy for ONE section of the org's public brokerage website, grounded in real portfolio facts (markets, property-type mix, counts) and screened for Fair Housing compliance.
lookup_brokerage_sitereadRead safe branding, custom-domain status, page definitions, public team profiles, and the installed website theme catalog.
lookup_leadsreadList or inspect authenticated staff lead-pipeline records, find duplicate leads, or read lead data-quality rules.
lookup_listingsreadSearch listings across the portfolio.
lookup_prospectsreadSearch the CRM prospects pipeline.
lookup_showingsreadList organization showings with listing, visitor, schedule, status, rating, and feedback context.
manage_brokerage_siteproposesCreate/update/delete brokerage pages and public team profiles.
manage_leadsproposesCreate/update/delete lead-pipeline records, merge duplicate leads, capture staff feedback, and set lead data-quality rules.
publish_listingwritePublish or unpublish a listing.
set_prospect_statuswriteMove a prospect through the pipeline (NEW → CONTACTED → SHOWING_SCHEDULED → SHOWED → APPLICATION_SENT → APPLIED → CONVERTED, or LOST at any time).
unarchive_prospectwriteRestore an archived prospect into the active inbox.
update_listingwriteUpdate an existing listing — change price, description, title, available date, features, etc.
update_prospectwriteEdit a prospect's contact info, desired criteria, or notes.
update_showingproposesUpdate a showing's status, rating or feedback, or move it to a new day and time (date + startTime, optional endTime, in the office's time zone).
upload_listing_photoswriteUpload raw base64 photos for a listing.
Maintenance14 tools
add_maintenance_commentwritePost a comment on a maintenance work order — the running comms trail for that job.
assign_vendorwriteAssign a vendor to a maintenance work order and notify them with the standard dispatch message (work order details + accept/decline link) over their best channel — linked chat, opted-in SMS, or email.
complete_work_orderproposesMark a maintenance work order COMPLETED and optionally capture the final cost — the cost creates a MAINTENANCE expense linked to the work order (vendor and property inherited), which posts to the b…
create_maintenance_requestwriteCreate a maintenance work order.
export_maintenancereadExport matching work orders as CSV or Excel (.xlsx).
lookup_inventoryreadMaintenance parts inventory: search the parts catalog (by name, SKU, barcode or category), one part with its stock at each location, what is at a location (a shop, a tech's truck, a storage room —…
lookup_maintainxreadRead live MaintainX connection, work-order, location, and work-request data without exposing the provider credential.
lookup_maintenancereadSearch maintenance work orders.
lookup_maintenance_clustersreadList recurring maintenance issue clusters, inspect one cluster, or compare vendor callback rates.
manage_inventory_catalogwriteOwners and managers: add, edit, archive, restore or delete parts in the maintenance parts catalog, and add, edit, archive or restore stock locations (a SHOP, a tech's TRUCK with the person who carr…
manage_work_orderwriteUpdate every staff-editable work-order field, approve a same-visit group, or govern recurring-issue clusters.
move_inventorywriteMove maintenance parts and record where they went.
request_work_order_entry_permissionproposesSend a tenant an entry-permission request for a work order.
update_maintenance_statuswriteUpdate the status of a maintenance work order.
Vendors6 tools
create_vendorwriteAdd a new vendor (1099 contractor) or W-2 employee payee to the organization.
invite_vendorproposesEmail a vendor an invite to activate their portal seat — they create an account, see work orders and tasks assigned to them, and choose text/WhatsApp notification preferences.
lookup_vendorreadSearch active vendors in this organization by name, contact, or specialty.
manage_vendor_profilewriteUpdate/deactivate vendors and create/respond to performance reviews.
message_vendorproposesSend an operational message to a vendor — dispatch details, a problem description, scheduling, follow-ups ('tell the plumber the leak is back at unit 4B').
request_vendor_w9proposesEmail a vendor a secure link to collect their W-9 (needed to file year-end 1099s).
Accounting86 tools
adjust_billproposesAdjust, void or waive a bill the tenant has ALREADY been charged — "waive the late fee", "take that charge off", "forgive it", "she should not have been billed for that", "reduce it to $50", "that…
adjust_owner_contributionproposesAdjust an existing owner contribution (amount, date, memo, type, or property).
apply_late_feesproposesCHARGE late fees: sweeps overdue bills and posts the configured fee to each eligible one.
apply_tenant_creditproposesApply available tenant credits FIFO to an outstanding bill.
approve_expenseproposesApprove a pending expense/vendor bill so it can be paid — moves it to APPROVED and records who approved it.
bulk_approve_expensesproposesApprove or reject many expenses at once — the AP clerk's 'clear the queue' action.
cancel_vendor_payoutwriteCancel a vendor payout that hasn't been paid yet (DRAFT or PENDING).
close_accounting_periodproposesClose an accounting period (year/month) so it is locked: after close, back-dated bills or payouts into that month are rejected until it is reopened.
create_application_invoiceproposesCreate an applicant security-deposit invoice.
create_billproposesCharge a tenant — creates a receivable they owe you.
create_creditproposesApply a credit to a tenant's account.
create_expenseproposesLog an expense against a property, unit, and/or vendor.
create_recurring_billproposesSet up a recurring billing rule that automatically generates bills each month.
delete_billproposesHARD-delete a bill (Receivable).
delete_expenseproposesHARD-delete an expense.
delete_owner_contributionproposesDelete an owner contribution.
delete_recovery_periodproposesDelete one known DRAFT or REVIEW recovery period.
delete_recovery_poolproposesDelete one known recovery pool.
delete_tenant_creditproposesRemove a credit that was issued by hand on a tenant ledger (the "Issue credit" button).
dispose_security_depositproposesDispose a lease security deposit with refund, forfeiture, and itemized deductions.
export_recovery_periodreadGenerate a downloadable CSV audit backup or persisted CAM statement PDF without recalculating the period.
get_close_checklistreadThe month-end close checklist for a given year/month: read-only checks (unposted/draft bills, open accounts payable, unreconciled bank activity, unposted CAM recoveries, journal entries to review)…
get_financial_overviewreadPer-property P&L summary — income by type, operating/non-operating expenses, NOI, and net income, with monthly columns plus a period total.
get_gl_driftreadDiagnose drift between the operational subledgers and the general ledger: whether the trial balance ties (debits = credits), whether GL accounts payable ties to open bills, and whether GL accounts…
initiate_entity_payoutproposesInitiate a landlord withdrawal: move collected funds from a business entity's settlement balance to the entity's own linked bank account by ACH.
lookup_accounting_periodsreadList recent accounting periods or compute the close checklist for one month.
lookup_accounting_reportreadRun a classic accounting report for chat/MCP: rent-roll (as-of occupancy + rent + open balances), owner-statement (cash receipts vs paid expenses + distributions for a period), or general-ledger (s…
lookup_billing_reminder_rulereadRead the organization default or one receivable-specific billing reminder rule.
lookup_billsreadLook up outstanding bills (receivables) for a tenant or unit — money owed TO you by a tenant.
lookup_budgetsreadList budget detail and budget-vs-actual variance.
lookup_check_queuereadList checks waiting to be printed or mailed.
lookup_commercial_analyticsreadRun a safe commercial property projection or critical-date digest.
lookup_commercial_recoveryreadRead every CAM / triple net (NNN) recovery view: what share each tenant pays, what vacancy cost the owner (vacant suites the landlord absorbs), shared scopes, pools and budgets, lease recovery rule…
lookup_entity_payoutsreadLandlord withdrawal history for a business entity — every transfer to the entity's bank with amount, status (pending | in_transit | paid | failed | returned), destination bank, and memo — plus the…
lookup_expense_approval_rulesreadList the organization AP approval rules.
lookup_expensesreadList AP expenses/receipts with approval and payout state.
lookup_investor_payoutsreadList owner/investor distribution runs, or one run with each investor's share, how it was paid (bank transfer, check or wire) and whether it has been recorded as paid.
lookup_payablesreadThe accounts-payable worklist: approved, unpaid bills that are ready to pay, grouped by vendor with totals and W-9 status.
lookup_paymentsreadLook up payment history for a tenant or lease.
lookup_portfolio_ledgerreadRead the combined portfolio income/expense register with totals.
lookup_reconciliationreadSummarize the org's reconciliation state: count of unreconciled bank transactions, optionally returning the most recent unreconciled rows so the assistant can offer targeted matches.
lookup_recurring_billsreadList recurring tenant charge rules and price-change history.
lookup_rent_collection_reportreadDelinquency and collection analytics over time: for each month and each property, the share of charges paid on time vs late vs still unpaid, delinquency rate, amounts billed vs collected, average d…
lookup_security_depositreadRead the contract, held balance, status, and itemized security-deposit deductions for a lease.
lookup_utility_allocationsreadList or inspect RUBS/utility allocation runs.
lookup_vendor_payment_readinessreadCheck whether a vendor can be paid by ACH right now, and what is missing if not.
lookup_vendor_payoutsreadList vendor payouts (disbursements) with their status — pending, paid, canceled, failed.
mail_checkproposesMail one paper check by USPS First Class, drawn on the register's own routing and account number.
manage_bank_depositproposesCreate or undo an aggregate deposit of known pending payment ids.
manage_billing_reminder_rulewriteSet the organization default, set a receivable override, or reset a receivable to the default reminder rule.
manage_budgetwriteCreate, update, replace lines, or delete a property/portfolio budget.
manage_investor_payoutproposesWork out and record an owner/investor distribution for a property and period.
manage_lease_chargesproposesManage a lease's recurring charge lines — the Yardi-style charge schedule.
manage_recovery_budgetwriteChange what a budget line is for ONE YEAR — this is the yearly figure the Budget tab, readiness, and every tenant's monthly estimate use.
manage_recovery_periodwriteYear-end CAM / NNN reconciliation (the true-up): create the period for a year, calculate it (recover the surplus, recapture the operating expense overage tenants owe, credit what they overpaid), an…
manage_recovery_poolwriteCreate or update a BUDGET LINE (a CAM / NNN expense pool): its name, yearly budget, whether tenants pay it (recoverable) or the owner only, and which vendor-bill categories it collects.
manage_recovery_rulewriteUpsert full advanced lease recovery terms, quick-edit tenant billing fields, or calculate all active-lease shares for a property.
manage_recovery_scopewriteGroup properties into a CAM/NNN shared expense pool scope (a plaza/center reconciled together), or edit one.
manage_recurring_billproposesUpdate, pause, resume, or permanently delete an unused recurring tenant charge rule.
manage_tenant_paymentproposesEdit, confirm, or reject a pending/manual tenant payment.
manage_utility_allocationproposesPost tenant utility charges or reverse an unpaid RUBS allocation.
manage_vendor_invoiceproposesCreate, approve, reject, void, or pay a vendor invoice.
mark_vendor_payout_paidproposesMark a vendor payout as PAID once the money has actually gone out (e.g.
pay_vendorproposesIssue a payout (disbursement) to a vendor — the landlord→vendor payment.
post_recovery_estimatesproposesPut each tenant's monthly CAM / expense-recovery estimate (their share of the year's recoverable budget ÷ 12) on their ledger: creates the monthly CAM_CHARGES recurring charge where none exists, co…
post_recovery_periodproposesPost an approved reconciliation to tenant CAM receivables and credits, then lock the period.
preview_utility_allocationreadCompute a RUBS utility allocation without writing charges.
print_checksproposesPrint one unsigned paper check from the queue.
record_account_transferproposesRecord a cash-to-cash transfer between two of the org's GL accounts (e.g.
record_bank_transactionproposesRecord, update or void a manual check, deposit, fee, transfer side, or electronic bank-register entry.
record_expense_batchproposesAtomically record a shared-property split or a reviewed multi-line vendor bill.
record_offline_bank_paymentproposesBook incoming rent that already appears on the bank feed (Zelle, mailed check, cash, ACH) and match that deposit.
record_owner_contributionproposesRecord a capital contribution from a rental owner on a specific property.
record_paymentproposesRecord a manual payment (cash, check, money order) RECEIVED FROM A TENANT against their bill — accounts receivable, money coming in.
record_recovery_expenseproposesRecord a vendor expense into a recovery pool, optionally splitting one invoice across multiple scoped properties.
reject_expenseproposesReject a pending or approved (unpaid) expense/vendor bill — moves it to REJECTED and backs its accrual out of the books.
reopen_accounting_periodwriteReopen a previously closed accounting period (year/month) so back-dated entries can post into it again.
run_recurring_billing_cycleproposesMaterialize due recurring charges for only the active organization.
run_trust_reconciliationreadThree-way trust reconciliation for security deposits and escrow: compares (A) funds actually held — online security-deposit balances still on the way to the bank plus cleared balances on trust bank…
send_invoiceproposesEmail tenants a reminder about money they owe, with a link to pay in their tenant portal.
send_recovery_statementsproposesEmail each tenant their own CAM reconciliation statement PDF for an approved/posted period (never another tenant's numbers).
setup_vendor_paymentsproposesCreate a vendor's receive-only payment account so they can be paid electronically.
suggest_expense_from_receiptproposesTouchless AP intake: take the fields read off a vendor receipt/invoice (vendor name, amount, date, description) and draft a bill for review.
sync_recovery_rule_from_leasewriteFill a lease's CAM / triple-net (NNN) recovery rule by reading its stored signed lease PDF: pro-rata share, base year, expense stop, CAM admin fee, and monthly CAM/tax/insurance escrows are extract…
unrecord_expense_paymentproposesReturn a paid expense to approved/unpaid and reverse its cash posting.
update_expenseproposesCorrect fields on an existing expense: amount, date, category, vendor, property, unit, description, notes, status, or which CAM budget line it counts toward (recoveryPoolId).
Reports7 tools
email_custom_reportproposesEmail a report YOU assembled as a real PDF/XLSX/CSV file, with the same table rendered in the email body.
email_operational_reportproposesGenerate any operational report as a real PDF, XLSX, or CSV file and EMAIL IT AS AN ATTACHMENT.
lookup_report_artifactsreadList generated owner/investor report packages without storage keys or signed credentials.
lookup_reporting_configurationreadRead report schedules and syndication readiness/configuration.
manage_report_artifactproposesGenerate/regenerate an owner statement artifact or explicitly email an existing package.
manage_reporting_configurationproposesCreate/update/delete report delivery schedules.
run_operational_reportreadRun one of the platform's operational reports and get its rows — directories, leasing pipeline, vacancies, work orders, unpaid bills, delinquencies, rent collection, deposits, insurance, inspection…
Documents15 tools
cancel_signature_requestwriteCancel an in-flight e-signature request: existing signing links stop working and the document no longer awaits signatures.
lookup_document_templatesreadList or inspect reusable PDF document templates.
lookup_documentsreadList, inspect, or prepare safe document downloads with sanitized signature status.
lookup_signature_lifecyclereadList and inspect signature-request lifecycle, signer status, certificate readiness, evidence readiness, and tamper-verification metadata without exposing signer bearer tokens or binary archives.
lookup_signature_requestsreadList the org's e-signature requests with per-signer status (who signed, who is still pending), newest first.
lookup_user_signaturesreadList the current user saved signature library without returning signature image/text payloads.
manage_documentproposesCreate/update/delete document metadata or render a template document with merge values.
manage_document_templateproposesCreate/update/delete/preview/import a reusable PDF template.
manage_signature_fieldsproposesReplace or remove field placements on a non-terminal signature request.
read_documentreadRead the actual text of a stored document (PDF or plain text/CSV) so you can answer questions about what it SAYS.
release_signature_requestproposesRelease a field-placement draft and email its signing invitations.
resend_signature_requestproposesRe-send the signing email to everyone who has not yet signed on an e-signature request (or to one specific signer via signerId).
send_document_template_for_signingproposesMerge a template, create a working document, and issue a signature request.
send_generic_signature_requestproposesCreate a signature request for any org document.
upload_documentwriteUpload a local file (PDF, CSV, XLSX, TXT, or image) from base64 bytes and create a Document row.
Communications11 tools
lookup_announcementsreadList or inspect tenant announcements and preview the size of a target audience.
lookup_email_templatesreadList, inspect, or preview reusable organization email templates.
lookup_email_workspacereadList org email threads/conversations/messages, unread state, recipients, members, accountant contacts, or mail configuration.
manage_announcement_draftwriteCreate, edit, or delete an unsent tenant announcement draft.
manage_email_attachmentwritePrepare, finalize, or delete an email attachment.
manage_email_templatewriteCreate/update/delete or seed reusable email templates.
manage_email_threadwriteMark read/unread, star/unstar, assign/unassign, archive/unarchive, trash/restore, or bulk-update email threads.
send_announcementproposesSend an announcement to tenants via email.
send_emailproposesCompose and send a branded email from the org Inbox (same path as /inbox → New message).
send_email_template_testproposesRender and send a real test email from an email template.
send_email_thread_messageproposesReply to or forward an existing email thread, or after approval send invoice and tax files from a thread to the accountant.
Workspace36 tools
answer_askwriteAnswer an ask that was asked of the caller: reply (a note on the thread; the asker hears it), done (mark it finished, optionally with what was found or sent), or hand_back (give it back to whoever…
apply_task_templatewriteLay a task template out from an anchor date: each item becomes a task due anchor + offsetDays, assigned to its named person, else the first accepted member holding its role, else the caller, and li…
ask_teammatewriteAsk a teammate for something and wait on the answer: "ask Sam for the Maple Court key log by Friday".
complete_taskwriteMark a task as completed (records who completed it).
create_notewriteAdd a note to a property, unit, tenant, lease, or vendor.
create_taskwriteCreate a task/reminder.
follow_up_askwriteFollow up on an ask the caller made: reply (a note; whoever has it hears it), withdraw (no longer wanted; whoever has it hears so), or ask_again (hand it back out — to whoever handed it back by def…
list_notification_prefsreadShow the user what proactive Telegram notifications they currently receive and which topics they have muted.
load_skillreadLoad a step-by-step playbook for a multi-step job (month-end close, move-out deposit disposition, delinquency sweep, QuickBooks setup, bulk document intake).
lookup_asksreadThe caller's asks between teammates: what teammates asked of them (open), what was handed back to them, what they are waiting on from others, and what was answered in the last week.
lookup_context_requestsreadRead the questions an assistant has parked for a human on the Approvals page ('Needs your input').
lookup_my_preferencesreadRead the current user's own assistant preferences (tone, verbosity, answer language, standing instruction, default property) and the personal notes the assistant has saved about them.
lookup_notesreadLook up notes attached to properties, units, tenants, or leases.
lookup_notificationsreadList the current user in-app notifications and unread count.
lookup_operations_calendarreadRead the calendar the person sees on /calendar: work orders, inspections, showings, tasks and lease dates for the office (a resident sees only their own unit, lease and rent due days; a vendor only…
lookup_schedulereadRead a person's calendar: their meetings (typed into Proppely or read from their connected Google/Outlook/iCal calendar), work orders scheduled to them, and showings assigned to them; their connect…
lookup_task_templatesreadThe org's task templates — reusable checklists laid out from a date (a unit turn from the day a unit enters make-ready, renewal steps N days before a lease ends, move-in and move-out checklists) —…
lookup_tasksreadLook up tasks/reminders.
lookup_teamreadLook up team members in the organization.
lookup_team_trainingreadTeam training: the training videos an owner or manager requires the staff to watch (curricula set on the Team training page, /learn/team) and who on the team has watched them.
lookup_timereadRead time on work orders: my running timer, my week or a teammate's week (managers and accountants), time entries with filters, what is waiting for approval, time held for a manager's OK, the labor…
manage_my_preferenceswriteSave how THIS user wants the assistant to behave, or remember/forget a lasting personal note about them.
manage_noteproposesUpdate/pin or delete an organization note.
manage_notificationswriteMark one or all current-user in-app notifications read.
manage_schedulewriteChange a calendar: add, move, rename or remove a meeting or block typed into Proppely; set working hours (the windows the planner may fill); read a connected calendar again now; disconnect a connec…
manage_taskwriteFull task lifecycle: update, assign/unassign, comment, recurrence, complete/reopen, or delete.
manage_task_templatewriteCreate, edit, archive or restore a task template, or add starter templates (unit turn, lease renewal, move-in, move-out).
manage_time_entrywriteLog, correct or delete time entries.
manage_timerwriteRun the caller's own clock on a work order or task: start (a running clock is stopped and saved first), pause, resume, stop (saves the time to the caller's week; a clock that ran 12 hours or more w…
manage_timesheetwriteWeeks and approvals.
manage_user_preferenceswriteDeep-merge the current member dashboard preferences.
read_memoryreadLook up this organization's saved house rules, preferences, and vendor/accounting rules (org memory).
report_customer_feedbackwriteFile a product complaint or suggestion about Proppely itself into the platform admin inbox (Customer Complaints & Suggestions).
search_assistant_toolsreadSearch the full assistant tool catalog when the capability you need is not in your current tool list.
set_notification_prefreadMute or unmute a proactive Telegram notification topic for the current user.
set_task_pingswriteTurn "pinged on every task" on or off for a team member: they get a copy of every task handed out in the org ("Task for Sam: …") and the whole team's due and overdue work in the morning digest.
Associations2 tools
lookup_association_managementreadRead association settings, owners, board, dues, violations, ARC, tenants, elections, meetings, reserves, and applications.
manage_associationproposesManage HOA/association governance and financial configuration.
BankingRestricted18 tools
analyze_bank_reconciliationreadRead-only bank feed analysis for a date range: unmatched transactions, rule-based (optional AI) match suggestions, and variance of bank deposits/debits vs recorded receipts and the owner-statement…
lookup_bank_connectionsreadList Plaid bank-feed connections without returning encrypted access tokens.
lookup_bank_statementsreadList reconciliation statement closes and their locked transaction counts.
lookup_bank_transactionsreadList bank transactions from a specific bank account (the register).
lookup_bankingreadList the org's bank accounts with current balance, last sync time, active state, and Plaid connection info.
lookup_payment_entitiesreadOnline rent-collection setup in one read: every business entity (LLC) with verification status, the balances on the way to its bank (an operating account for rent, a trust account for security depo…
lookup_payout_routingreadList the organization's business entities — the LLCs / companies that own properties and collect rent — with verification status, whether each collects rent online and pays out, its operating bank…
lookup_plaid_statusreadList Plaid connections and whether they look healthy: institution, account name, last sync time, and how long ago it was.
manage_bank_accountwriteAdd a bank account with just a name — everything else is optional and can be filled in later (bank name, checking/savings, last four, opening balance, trust flag).
manage_bank_connectionproposesSync or disconnect an existing Plaid bank-feed connection, or fill_account_numbers to copy the bank-verified routing number and full account number onto the bank accounts the connection backs.
manage_bank_statementproposesClose a balanced reconciliation statement period or reopen it.
manage_entity_walletsproposesConfigure the settlement accounts of a verified business entity — the segregated balances online rent and security deposits collect into before landing in the entity's bank (an operating account fo…
manage_payout_routingwriteAdd a business entity (LLC / company / owner entity) — a bank account with the same name is created with it, so rent lands there and bills are paid from it; or rename an entity, make it the organiz…
manage_property_wallet_routingproposesChange where a property's ONLINE rent and/or security deposits settle within its business entity: name the entity's operating or trust account, or pass 'default' to clear an override back to the en…
match_bank_transactionwriteReconcile a bank transaction by linking it to a Payment, VendorInvoice, Payout, manual Expense, Transfer, or marking it IGNORED.
sync_bank_feedwritePull the latest transactions from the bank feed (Plaid) and run the auto-matcher against existing payments, payouts, and expenses.
unmatch_bank_transactionwriteUndo a manual reconciliation on a bank transaction.
withdraw_connect_walletproposesLEGACY — only for organizations still on the previous payment rail.
ScreeningRestricted8 tools
lookup_screeningreadCheck organization-scoped screening/background-check status for an applicant.
lookup_screening_providerreadRead the active screening provider, connection readiness, configured product, and supported workflow capabilities without exposing credentials.
lookup_screening_requestsreadRead organization-scoped screening status and safe result summaries.
refresh_screening_statuswritePoll the configured provider for one organization-owned screening and synchronize its encrypted report/status.
request_application_screeningproposesInitiate the configured provider background check on a residential RentalApplication.
request_screeningproposesInitiate a provider-hosted consumer screening outside an existing application.
resend_screening_inviteproposesRe-send the applicant's hosted screening link by email for one organization-owned screening.
send_screening_adverse_actionproposesSend the FCRA adverse-action notice for a completed screening.
Tax and payrollRestricted8 tools
lookup_tax_1099readRead vendor 1099-NEC threshold, eligibility, filing history, or correction preview.
lookup_tax_w2readRead the W-2 roster for a tax year: every W-2 employee (workerClassification EMPLOYEE) with tax-identity readiness (SSN/address on file — last-4 only), boxes computed from paid wage stubs, employer…
lookup_wage_paymentsreadRead W-2 pay stubs (wage payments) — list by employee/year/status, preview a stub (FICA suggestion + net pay from gross and withholdings, nothing written), or read payroll tax deposits and the Payr…
manage_tax_1099proposesSubmit original 1099s, file corrections, or run the notify-only federal threshold watch.
manage_tax_w2proposesSubmit W-2s for a tax year to TaxBandits (create + transmit to the SSA when transmit is on), transmit previously created records, or refresh filing status from the provider.
manage_w2_worksheetwriteEdit the W-2 boxes for one employee-year (overrides the stub-computed values — e.g.
manage_wage_paymentsproposesVoid a pending / off-platform pay stub, retry a FAILED stub (re-sends the net pay on the rail), or record a payroll tax deposit the employer remitted to the IRS/state (books DR Payroll Liabilities…
pay_employeeproposesIssue a W-2 pay stub and send the NET pay to an employee (workerClassification EMPLOYEE) on the same payout rail Proppely Payments uses for vendors — standard ACH pulled from the operating bank acc…
Versioning
The API version is 2026-11-08. Every event carries the payload version in apiVersion, and each webhook endpoint records the version it was created with. Tool schemas come from the code, so a change to one shows up in the OpenAPI document when it ships.