{"items":[{"type":"link","label":"RentEngine Public API","link":"/openapi/openapi","routeSlug":"/openapi/openapi"},{"type":"link","label":"Authorization","link":"/openapi/openapi/section/authorization","routeSlug":"/openapi/openapi/section/authorization"},{"type":"link","label":"Obtaining API Tokens","link":"/openapi/openapi/section/obtaining-api-tokens","routeSlug":"/openapi/openapi/section/obtaining-api-tokens"},{"type":"link","label":"Using API Tokens","link":"/openapi/openapi/section/using-api-tokens","routeSlug":"/openapi/openapi/section/using-api-tokens"},{"type":"link","label":"Token Security Best Practices","link":"/openapi/openapi/section/token-security-best-practices","routeSlug":"/openapi/openapi/section/token-security-best-practices"},{"type":"link","label":"Token Permissions","link":"/openapi/openapi/section/token-permissions","routeSlug":"/openapi/openapi/section/token-permissions"},{"type":"link","label":"Invalidating Tokens","link":"/openapi/openapi/section/invalidating-tokens","routeSlug":"/openapi/openapi/section/invalidating-tokens"},{"type":"link","label":"Pagination","link":"/openapi/openapi/section/pagination","routeSlug":"/openapi/openapi/section/pagination"},{"type":"link","label":"Response Format A — Bare Array (legacy)","link":"/openapi/openapi/section/response-format-a-bare-array-(legacy)","routeSlug":"/openapi/openapi/section/response-format-a-bare-array-(legacy)"},{"type":"link","label":"Response Format B — Envelope with Page Metadata","link":"/openapi/openapi/section/response-format-b-envelope-with-page-metadata","routeSlug":"/openapi/openapi/section/response-format-b-envelope-with-page-metadata"},{"type":"link","label":"Rate Limiting","link":"/openapi/openapi/section/rate-limiting","routeSlug":"/openapi/openapi/section/rate-limiting"},{"type":"link","label":"Webhooks","link":"/openapi/openapi/section/webhooks","routeSlug":"/openapi/openapi/section/webhooks"},{"type":"group","label":"Reporting","link":"/openapi/openapi/reporting","routeSlug":"/openapi/openapi/reporting","items":[{"label":"Get unit leasing performance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getunitleasingperformance","routeSlug":"/openapi/openapi/reporting/getunitleasingperformance","metadata":{"seo":{"title":"Get unit leasing performance","description":"Retrieve leasing performance metrics for a specific unit within a date range."}},"httpPath":"/reporting/leasing-performance/units/{unitId}"},{"label":"List prospects report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getreportingprospects","routeSlug":"/openapi/openapi/reporting/getreportingprospects","metadata":{"seo":{"title":"List prospects report","description":"Row-level prospect data backing the Intelligence dashboard's Prospects table, for the given accounts and date range."}},"httpPath":"/reporting/prospects"},{"label":"List units report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getreportingunits","routeSlug":"/openapi/openapi/reporting/getreportingunits","metadata":{"seo":{"title":"List units report","description":"Row-level unit/property data backing the Intelligence dashboard's Properties table, for the given accounts and date range."}},"httpPath":"/reporting/units"},{"label":"List showings report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getreportingshowings","routeSlug":"/openapi/openapi/reporting/getreportingshowings","metadata":{"seo":{"title":"List showings report","description":"Row-level showing data backing the Intelligence dashboard's Showings table, for the given accounts and date range."}},"httpPath":"/reporting/showings"},{"label":"List prescreening report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getreportingprescreening","routeSlug":"/openapi/openapi/reporting/getreportingprescreening","metadata":{"seo":{"title":"List prescreening report","description":"Row-level prescreening data backing the Intelligence dashboard's Prescreening table, for the given accounts and date range."}},"httpPath":"/reporting/prescreening"},{"label":"List calls report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getreportingcalls","routeSlug":"/openapi/openapi/reporting/getreportingcalls","metadata":{"seo":{"title":"List calls report","description":"Row-level call data backing the Intelligence dashboard's Calls table, for the given accounts and date range."}},"httpPath":"/reporting/calls"},{"label":"List marketing sources report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getreportingmarketingsources","routeSlug":"/openapi/openapi/reporting/getreportingmarketingsources","metadata":{"seo":{"title":"List marketing sources report","description":"Per-source marketing performance backing the Intelligence dashboard's Marketing Sources table, for the given accounts and date range."}},"httpPath":"/reporting/marketing-sources"},{"label":"List applications report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getreportingapplications","routeSlug":"/openapi/openapi/reporting/getreportingapplications","metadata":{"seo":{"title":"List applications report","description":"Row-level application-group data backing the Intelligence dashboard's Applications table, for the given accounts and date range."}},"httpPath":"/reporting/applications"},{"label":"List agent performance report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/reporting/getreportingagentperformance","routeSlug":"/openapi/openapi/reporting/getreportingagentperformance","metadata":{"seo":{"title":"List agent performance report","description":"Per-agent performance metrics backing the Intelligence dashboard's Agent Performance table, for the given accounts and date range."}},"httpPath":"/reporting/agent-performance"}]},{"type":"group","label":"Lockboxes","link":"/openapi/openapi/lockboxes","routeSlug":"/openapi/openapi/lockboxes","items":[{"label":"Get lockboxes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/lockboxes/getlockboxes","routeSlug":"/openapi/openapi/lockboxes/getlockboxes","metadata":{"seo":{"title":"Get lockboxes","description":"Retrieve lockboxes with optional filtering and pagination"}},"httpPath":"/lockboxes"},{"label":"Create lockboxes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/lockboxes/postlockboxes","routeSlug":"/openapi/openapi/lockboxes/postlockboxes","metadata":{"seo":{"title":"Create lockboxes","description":"Create new lockboxes (currently only SentriLock type is supported)"}},"httpPath":"/lockboxes"},{"label":"Transfer lockboxes between accounts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/lockboxes/postlockboxestransferaccounts","routeSlug":"/openapi/openapi/lockboxes/postlockboxestransferaccounts","metadata":{"seo":{"title":"Transfer lockboxes between accounts","description":"Moves lockboxes between accounts. The user must have access to both the lockboxes and the target account."}},"httpPath":"/lockboxes/transfer_accounts"},{"label":"Generate a lockbox code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/lockboxes/postgeneratelockboxcode","routeSlug":"/openapi/openapi/lockboxes/postgeneratelockboxcode","metadata":{"seo":{"title":"Generate a lockbox code","description":"Generate a one-time code for a lockbox. The code can be generated by providing either a lockbox_id, serial_number, or unit_id. The code will be valid for the specified date."}},"httpPath":"/lockboxes/generate_code"}]},{"type":"group","label":"Lockbox Events","link":"/openapi/openapi/lockbox-events","routeSlug":"/openapi/openapi/lockbox-events","items":[{"label":"Get lockbox events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/lockbox-events/getlockboxevents","routeSlug":"/openapi/openapi/lockbox-events/getlockboxevents","metadata":{"seo":{"title":"Get lockbox events","description":"Retrieve lockbox events with optional filtering and pagination"}},"httpPath":"/lockbox_events"},{"label":"Create lockbox events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/lockbox-events/postlockboxevents","routeSlug":"/openapi/openapi/lockbox-events/postlockboxevents","metadata":{"seo":{"title":"Create lockbox events","description":"Create new lockbox events (Install or Uninstall)"}},"httpPath":"/lockbox_events"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Lockbox events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/openapi/lockbox-events/receive-lockbox-events","routeSlug":"/openapi/openapi/lockbox-events/receive-lockbox-events","metadata":{"seo":{"title":"Lockbox events","description":"Lockbox events"}},"httpPath":"LockboxEvents"}]},{"type":"group","label":"Lockbox Installations","link":"/openapi/openapi/lockbox-installations","routeSlug":"/openapi/openapi/lockbox-installations","items":[{"label":"Get lockbox installations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/lockbox-installations/getlockboxinstallations","routeSlug":"/openapi/openapi/lockbox-installations/getlockboxinstallations","metadata":{"seo":{"title":"Get lockbox installations","description":"Retrieve lockbox installations with optional filtering and pagination. Lockbox installations can only be created by inserting a lockbox event with event_type \"Install\"."}},"httpPath":"/lockbox_installations"}]},{"type":"group","label":"Units","link":"/openapi/openapi/units","routeSlug":"/openapi/openapi/units","items":[{"label":"Get units","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/units/getunits","routeSlug":"/openapi/openapi/units/getunits","metadata":{"seo":{"title":"Get units","description":"Retrieve units with optional filtering and pagination"}},"httpPath":"/units"},{"label":"Create or update a unit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/units/postunit","routeSlug":"/openapi/openapi/units/postunit","metadata":{"seo":{"title":"Create or update a unit","description":"Create a new unit or update an existing one."}},"httpPath":"/units"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Units","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/openapi/units/receive-units-updates","routeSlug":"/openapi/openapi/units/receive-units-updates","metadata":{"seo":{"title":"Units","description":"Webhook for unit changes (creates, updates, deletes).Only the below fields are included in the record and old_record objects."}},"httpPath":"UnitsEvents"}]},{"type":"group","label":"Market Tool","link":"/openapi/openapi/market-tool","routeSlug":"/openapi/openapi/market-tool","items":[{"label":"Get market comps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/market-tool/getmarkettoolcomps","routeSlug":"/openapi/openapi/market-tool/getmarkettoolcomps","metadata":{"seo":{"title":"Get market comps","description":"Retrieve normalized rental market comparables for a location, filteredby coordinates plus optional bed/bath/sqft/days-on-market/date criteria.Results are de-identified — no listing-provider references. Returns up to200 most recently active comparables; narrow the radius or filters for atighter result set."}},"httpPath":"/market-tool/comps"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Market tool leads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/openapi/market-tool/receive-market-tool-lead-events","routeSlug":"/openapi/openapi/market-tool/receive-market-tool-lead-events","metadata":{"seo":{"title":"Market tool leads","description":"Webhook for new business-development leads captured by the Market ToolWidget. Fires once per new lead (INSERT only) — no update or deleteevents. The record contains a fixed set of listing and lead-contactfields."}},"httpPath":"MarketToolLeads"}]},{"type":"group","label":"Prospects","link":"/openapi/openapi/prospects","routeSlug":"/openapi/openapi/prospects","items":[{"label":"Get prospects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/prospects/getprospects","routeSlug":"/openapi/openapi/prospects/getprospects","metadata":{"seo":{"title":"Get prospects","description":"Retrieve prospects with optional filtering and pagination"}},"httpPath":"/prospects"},{"label":"Create a prospect","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/prospects/postprospect","routeSlug":"/openapi/openapi/prospects/postprospect","metadata":{"seo":{"title":"Create a prospect","description":"Create a new prospect. Reuses the standard new-prospect workflow,which handles the initial leasing event, the new-lead notification to theaccount team, and (by default) sending the acknowledgement SMS to theprospect."}},"httpPath":"/prospects"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Prospects","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/openapi/prospects/receive-prospects-updates","routeSlug":"/openapi/openapi/prospects/receive-prospects-updates","metadata":{"seo":{"title":"Prospects","description":"Webhook for prospect changes (creates, updates, deletes).Only the below fields are included in the record and old_record objects."}},"httpPath":"ProspectsEvents"}]},{"type":"group","label":"Multifamily Properties","link":"/openapi/openapi/multifamily-properties","routeSlug":"/openapi/openapi/multifamily-properties","items":[{"label":"Get multifamily properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/multifamily-properties/getmultifamilyproperties","routeSlug":"/openapi/openapi/multifamily-properties/getmultifamilyproperties","metadata":{"seo":{"title":"Get multifamily properties","description":"Retrieve multifamily properties with optional filtering"}},"httpPath":"/multifamily_properties"},{"label":"Create or update a multifamily property","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/multifamily-properties/postmultifamilyproperties","routeSlug":"/openapi/openapi/multifamily-properties/postmultifamilyproperties","metadata":{"seo":{"title":"Create or update a multifamily property","description":"Create a new multifamily property or update an existing one"}},"httpPath":"/multifamily_properties"}]},{"type":"group","label":"Floorplans","link":"/openapi/openapi/floorplans","routeSlug":"/openapi/openapi/floorplans","items":[{"label":"Get floorplans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/floorplans/getfloorplans","routeSlug":"/openapi/openapi/floorplans/getfloorplans","metadata":{"seo":{"title":"Get floorplans","description":"Retrieve multifamily_prs with optional filtering"}},"httpPath":"/floorplans"},{"label":"Create or update a floorplan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/floorplans/postfloorplans","routeSlug":"/openapi/openapi/floorplans/postfloorplans","metadata":{"seo":{"title":"Create or update a floorplan","description":"Create a new floorplan or update an existing one"}},"httpPath":"/floorplans"}]},{"type":"group","label":"Leasing Events","link":"/openapi/openapi/leasing-events","routeSlug":"/openapi/openapi/leasing-events","items":[{"label":"List a prospect's leasing events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/leasing-events/getprospectleasingevents","routeSlug":"/openapi/openapi/leasing-events/getprospectleasingevents","metadata":{"seo":{"title":"List a prospect's leasing events","description":"Retrieve a prospect's leasing-event timeline (newest first), by prospect_id or phone (supply exactly one)."}},"httpPath":"/leasing_events"},{"label":"Create leasing events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/leasing-events/postleasingevents","routeSlug":"/openapi/openapi/leasing-events/postleasingevents","metadata":{"seo":{"title":"Create leasing events","description":"Create one or more leasing events. Additional event types will be supported in future releases."}},"httpPath":"/leasing_events"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Leasing events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/openapi/leasing-events/receive-leasing-events","routeSlug":"/openapi/openapi/leasing-events/receive-leasing-events","metadata":{"seo":{"title":"Leasing events","description":"Webhook for leasing events (creates, updates, deletes). Leasing events of the following types are supported: - \"New\" - \"Contacted, Awaiting Information\" - \"Showing Desired\" - \"Showing Scheduled\" - \"Showing Complete\" - \"Missed Showing\" - \"Ghosting\" - \"Application Sent to Prospect\" - \"Application Received\" - \"Application Pending\" - \"Application in Owner Review\" - \"Application Approved\" - \"Withdrawn\" - \"Application Rejected\" - \"Prescreen Submitted\" - \"Prescreen Rejected - Self reported credit\" - \"Prescreen Rejected - Self reported income\" - \"Prescreen Rejected - ID Verification\" - \"Prescreen Approved\" - \"Looking too early\" - \"Lease out for signing\" - \"Lease Signed\" - \"Deposit Received\" - \"Move-in Scheduled\" - \"Moved In\" - \"Unit of Interest Unavailable\" - \"Not Interested\" - \"Duplicate Lead\" - \"Still Deciding\" - \"HOA Application Sent To Prospect\" - \"HOA Application Submitted\" - \"HOA Application Approved\" - \"HOA Application Rejected\" - \"Showing Failed\" - \"Showing Canceled\" - \"Showing Confirmed\" - \"Arrived for Showing\" - \"Showing Started\" - \"Log Note\" - \"Assign to User\" - \"Blocklist Prospect\" - \"Unblock Prospect\" - \"Reassign Showing\""}},"httpPath":"LeasingEvents"}]},{"type":"group","label":"Calls","link":"/openapi/openapi/calls","routeSlug":"/openapi/openapi/calls","items":[{"label":"List a prospect's calls","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/calls/getprospectcalls","routeSlug":"/openapi/openapi/calls/getprospectcalls","metadata":{"seo":{"title":"List a prospect's calls","description":"Retrieve a prospect's call history (newest first), by prospect_id or phone (supply exactly one)."}},"httpPath":"/calls"}]},{"type":"group","label":"Messages","link":"/openapi/openapi/messages","routeSlug":"/openapi/openapi/messages","items":[{"label":"List a prospect's messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/messages/getprospectmessages","routeSlug":"/openapi/openapi/messages/getprospectmessages","metadata":{"seo":{"title":"List a prospect's messages","description":"Retrieve a prospect's SMS history (newest first), by prospect_id or phone (supply exactly one)."}},"httpPath":"/messages"}]},{"type":"group","label":"Subteams","link":"/openapi/openapi/subteams","routeSlug":"/openapi/openapi/subteams","items":[{"label":"Get subteams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/subteams/getsubteams","routeSlug":"/openapi/openapi/subteams/getsubteams","metadata":{"seo":{"title":"Get subteams","description":"Retrieve subteams with optional filtering and pagination"}},"httpPath":"/subteams"}]},{"type":"group","label":"Prescreening Templates","link":"/openapi/openapi/prescreening-templates","routeSlug":"/openapi/openapi/prescreening-templates","items":[{"label":"Get prescreening templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/prescreening-templates/getprescreeningtemplates","routeSlug":"/openapi/openapi/prescreening-templates/getprescreeningtemplates","metadata":{"seo":{"title":"Get prescreening templates","description":"Retrieve prescreening templates with optional filtering and pagination"}},"httpPath":"/prescreening_templates"}]},{"type":"group","label":"Showings","link":"/openapi/openapi/showings","routeSlug":"/openapi/openapi/showings","items":[{"label":"Get unit showing availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/showings/getshowingavailability","routeSlug":"/openapi/openapi/showings/getshowingavailability","metadata":{"seo":{"title":"Get unit showing availability","description":"Retrieve showing availability for a specific unit, including available and preferred showing windows"}},"httpPath":"/showings/availability"},{"label":"Create a showing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/showings/createshowing","routeSlug":"/openapi/openapi/showings/createshowing","metadata":{"seo":{"title":"Create a showing","description":"Create a new showing for a unit. This endpoint handles both new showings and rescheduling of existing showings."}},"httpPath":"/showings/create"}]},{"type":"group","label":"Marketing","link":"/openapi/openapi/marketing","routeSlug":"/openapi/openapi/marketing","items":[{"label":"Get marketing listings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/marketing/getmarketinglistings","routeSlug":"/openapi/openapi/marketing/getmarketinglistings","metadata":{"seo":{"title":"Get marketing listings","description":"Retrieve marketing listings for a specific account. This endpoint is designed for embedding listings on external websites and marketing platforms."}},"httpPath":"/marketing/listings/{accountId}"}]},{"type":"group","label":"Rental Applications","link":"/openapi/openapi/rental-applications","routeSlug":"/openapi/openapi/rental-applications","items":[{"label":"List rental application groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/rental-applications/listrentalapplicationgroups","routeSlug":"/openapi/openapi/rental-applications/listrentalapplicationgroups","metadata":{"seo":{"title":"List rental application groups","description":"Retrieve rental application groups with filters, sorting, and pagination. Each grouprepresents a single party applying to a unit and bundles one or more applicants.The response embeds a non-PII summary for each applicant including screening status."}},"httpPath":"/rental_application_groups"},{"label":"Get a rental application group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/rental-applications/getrentalapplicationgroup","routeSlug":"/openapi/openapi/rental-applications/getrentalapplicationgroup","metadata":{"seo":{"title":"Get a rental application group","description":"Retrieve a single rental application group with its applicants (non-PII summary), screening status for each applicant, and the full decision history."}},"httpPath":"/rental_application_groups/{id}"},{"label":"Get a rental application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/rental-applications/getrentalapplication","routeSlug":"/openapi/openapi/rental-applications/getrentalapplication","metadata":{"seo":{"title":"Get a rental application","description":"Retrieve a single rental application (applicant record) with all data broken outand structured, including PII (personal details, income, address history, co-applicants,pets, vehicles, custom questions). Includes a documents array with opaquedocument_id values that can be passed toGET /rental_applications/{id}/documents/{documentId} to stream the actual file bytes."}},"httpPath":"/rental_applications/{id}"},{"label":"Download a rental application document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/rental-applications/getrentalapplicationdocument","routeSlug":"/openapi/openapi/rental-applications/getrentalapplicationdocument","metadata":{"seo":{"title":"Download a rental application document","description":"Stream the raw bytes of a document associated with a rental application."}},"httpPath":"/rental_applications/{id}/documents/{documentId}"},{"label":"Get a rental application's submitted income","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/rental-applications/getrentalapplicationincome","routeSlug":"/openapi/openapi/rental-applications/getrentalapplicationincome","metadata":{"seo":{"title":"Get a rental application's submitted income","description":"Retrieve the applicant's submitted income, computed exactly as theHousehold / Applicant Summary does — the average of every present incomesource (income documents, payroll connection, bank connection) at its rawOCR / provider amount. No income is excluded for fraud or name/DOBmismatch; every present source with a positive amount contributes."}},"httpPath":"/rental_applications/{id}/income"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Rental application groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/openapi/rental-applications/receive-rental-application-group-updates","routeSlug":"/openapi/openapi/rental-applications/receive-rental-application-group-updates","metadata":{"seo":{"title":"Rental application groups","description":"Webhook for rental application group changes. Emits the following semantic events:"}},"httpPath":"RentalApplicationGroups"},{"label":"Rental applications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/openapi/rental-applications/receive-rental-application-updates","routeSlug":"/openapi/openapi/rental-applications/receive-rental-application-updates","metadata":{"seo":{"title":"Rental applications","description":"Webhook for individual rental application changes. Emits the following semantic events:"}},"httpPath":"RentalApplications"}]},{"type":"group","label":"Notes & Follow-ups","link":"/openapi/openapi/notes-and-follow-ups","routeSlug":"/openapi/openapi/notes-and-follow-ups","items":[{"label":"Create a prospect note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/notes-and-follow-ups/postnote","routeSlug":"/openapi/openapi/notes-and-follow-ups/postnote","metadata":{"seo":{"title":"Create a prospect note","description":"Create a note on a prospect. Notes are keyed by phone number, so the note appears on every prospect record sharing that number."}},"httpPath":"/notes"},{"label":"List a prospect's notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/notes-and-follow-ups/getnotes","routeSlug":"/openapi/openapi/notes-and-follow-ups/getnotes","metadata":{"seo":{"title":"List a prospect's notes","description":"Retrieve a prospect's notes (newest first), by prospect_id or phone (supply exactly one)."}},"httpPath":"/notes"},{"label":"Create a prospect follow-up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/notes-and-follow-ups/postfollowup","routeSlug":"/openapi/openapi/notes-and-follow-ups/postfollowup","metadata":{"seo":{"title":"Create a prospect follow-up","description":"Create a follow-up (a scheduled reminder) on a prospect. Ifremind_at is set, a push notification is sent to the user at thattime."}},"httpPath":"/followups"},{"label":"List a prospect's follow-ups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/openapi/notes-and-follow-ups/getfollowups","routeSlug":"/openapi/openapi/notes-and-follow-ups/getfollowups","metadata":{"seo":{"title":"List a prospect's follow-ups","description":"Retrieve a prospect's active follow-ups (newest first), by prospect_id or phone (supply exactly one)."}},"httpPath":"/followups"}]}]}