# PropOps Help Center

## Docs

- [Account Types](https://help.propops.app/account-types.md): PropOps has three account types — Staff, Agent, and Contractor. Each has a distinct set of capabilities and a configurable permission set.
- [Dashboard](https://help.propops.app/analytics/dashboard.md): The PropOps dashboard gives you a real-time overview of job activity, key performance metrics, SLA status, and upcoming work at a glance.
- [Analytics Reports](https://help.propops.app/analytics/reports.md): Financial and user activity reports in PropOps — understand organisation performance, job volumes, and contractor spend.
- [API endpoint discovery](https://help.propops.app/api-reference/admin/api-endpoint-discovery.md): Dynamically scans the `/api` directory and returns all discovered endpoint metadata. Also supports health-checking endpoints and managing the API permission registry.
- [API permission matrix](https://help.propops.app/api-reference/admin/api-permission-matrix.md): Retrieve the current API permission assignments. **Required permission:** `api.admin.api-permissions.manage`
- [API usage statistics](https://help.propops.app/api-reference/admin/api-usage-statistics.md): Returns usage statistics per endpoint for auditing and monitoring. **Required permission:** `api.admin.api-usage-stats.manage`
- [Create or update a legal document](https://help.propops.app/api-reference/admin/create-or-update-a-legal-document.md): Save a legal document with rendered Markdown content. **Required permission:** `api.admin.documents.manage`
- [Create, update, or delete a document type](https://help.propops.app/api-reference/admin/create-update-or-delete-a-document-type.md): Manage document type configurations. **Required permission:** `api.admin.document-types.manage`
- [Create, update, or delete a job tag](https://help.propops.app/api-reference/admin/create-update-or-delete-a-job-tag.md): Manage job tag configurations. **Required permission:** `api.admin.job-tags.manage`
- [Delete a legal document](https://help.propops.app/api-reference/admin/delete-a-legal-document.md): Remove a legal document by ID. **Required permission:** `api.admin.documents.manage`
- [Disable a branch](https://help.propops.app/api-reference/admin/disable-a-branch.md): Disable a specific branch by ID. **Required permission:** `api.admin.branches.view`
- [Enable a branch](https://help.propops.app/api-reference/admin/enable-a-branch.md): Re-enable a previously disabled branch. **Required permission:** `api.admin.branches.view`
- [Generate security report](https://help.propops.app/api-reference/admin/generate-security-report.md): Returns a summary security report covering sessions, alerts, and access anomalies. **Required permission:** `api.admin.security-report.manage`
- [Get password breach status for all users](https://help.propops.app/api-reference/admin/get-password-breach-status-for-all-users.md): Returns all users with their password breach check status, count, and last check time. **Required permission:** `api.admin.password_breach_status.manage`
- [Get user management policy levels](https://help.propops.app/api-reference/admin/get-user-management-policy-levels.md): Retrieve the management hierarchy levels for roles and account types. **Required permission:** `api.admin.user_management_policy.manage`
- [Import, disable, enable, or delete branches](https://help.propops.app/api-reference/admin/import-disable-enable-or-delete-branches.md): Manage branches in bulk: - `bulk_import` — Import branches from CSV file - `bulk_disable` — Disable multiple branches - `bulk_delete` — Delete multiple branches - `bulk_assign_logo` — Assign logos to branches
- [List branches](https://help.propops.app/api-reference/admin/list-branches.md): Retrieve all branches with optional filters. **Required permission:** `api.admin.branches.view`
- [List document types](https://help.propops.app/api-reference/admin/list-document-types.md): Retrieve all configured document types for file uploads. **Required permission:** `api.admin.document-types.manage`
- [List job tags](https://help.propops.app/api-reference/admin/list-job-tags.md): Retrieve all configured job tags. **Required permission:** `api.admin.job-tags.manage`
- [List legal documents](https://help.propops.app/api-reference/admin/list-legal-documents.md): Retrieve all configured legal documents (terms, privacy policy, etc.). **Required permission:** `api.admin.documents.manage`
- [List permissions for dropdown](https://help.propops.app/api-reference/admin/list-permissions-for-dropdown.md): Returns all available permission keys formatted for dropdown selection. **Required permission:** `api.admin.permissions-dropdown.manage`
- [List roles](https://help.propops.app/api-reference/admin/list-roles.md): Retrieve all platform roles. **Required permission:** `api.admin.roles.manage`
- [Register API actions](https://help.propops.app/api-reference/admin/register-api-actions.md): Trigger registration of all API actions into the database. **Required permission:** `api.admin.api-discovery.manage`
- [Resend a transactional email](https://help.propops.app/api-reference/admin/resend-a-transactional-email.md): Re-send a previously sent transactional email by its log ID. **Required permission:** `api.admin.resend_email.manage`
- [Retrieve activity log](https://help.propops.app/api-reference/admin/retrieve-activity-log.md): Returns a paginated audit log of all user actions in the system. **Required permission:** `api.admin.activity-log.manage`
- [Retrieve all job documents (admin view)](https://help.propops.app/api-reference/admin/retrieve-all-job-documents-admin-view.md): Admin-level view of all job documents across branches. **Required permission:** `api.admin.job-documents.manage`
- [Retrieve email delivery logs](https://help.propops.app/api-reference/admin/retrieve-email-delivery-logs.md): Returns a log of all transactional emails sent by the platform. **Required permission:** `api.admin.email-logs.manage`
- [Scan for orphaned files](https://help.propops.app/api-reference/admin/scan-for-orphaned-files.md): Scans upload directories for files not referenced in the database. **Required permission:** `api.admin.orphaned_files.manage`
- [Settings overview statistics](https://help.propops.app/api-reference/admin/settings-overview-statistics.md): Returns aggregate statistics for the admin settings dashboard including user counts, branch counts, active sessions, security metrics, and more.
- [Update management policy level](https://help.propops.app/api-reference/admin/update-management-policy-level.md): Set the management level for a role or account type. Includes anti-escalation logic to prevent self-promotion. **Required permission:** `api.admin.user_management_policy.manage`
- [Update staff role permissions](https://help.propops.app/api-reference/admin/update-staff-role-permissions.md): Bulk-update permission assignments for roles. Uses dependency resolution to cascade related permissions.
- [View rate-limiting configuration and stats](https://help.propops.app/api-reference/admin/view-rate-limiting-configuration-and-stats.md): Returns current rate limit rules and recent throttle events. **Required permission:** `api.admin.rate-limiting.manage`
- [Assign or remove agent branch](https://help.propops.app/api-reference/agents/assign-or-remove-agent-branch.md): Assign an agent to a branch or remove the assignment. **Required permission:** `api.agents.branches.manage`
- [Create or update an SLA response time rule](https://help.propops.app/api-reference/agents/create-or-update-an-sla-response-time-rule.md): Configure SLA response time thresholds for specific job transitions. **Required permission:** `api.agents.branch_sla_response_times.manage`
- [Delete an SLA document](https://help.propops.app/api-reference/agents/delete-an-sla-document.md): Remove an uploaded SLA document. **Required permission:** `api.agents.branch_sla.manage`
- [Delete an SLA response time rule](https://help.propops.app/api-reference/agents/delete-an-sla-response-time-rule.md): Remove a configured SLA response time rule. **Required permission:** `api.agents.branch_sla_response_times.manage`
- [Delete branch logo](https://help.propops.app/api-reference/agents/delete-branch-logo.md): Remove the logo for a branch. **Required permission:** `api.agents.branch_logo.manage`
- [Get branch logo](https://help.propops.app/api-reference/agents/get-branch-logo.md): Retrieve the logo image for a branch. Returns an SVG placeholder if none is set. **Required permission:** `api.agents.branch_logo.manage`
- [Get branch profile popover data](https://help.propops.app/api-reference/agents/get-branch-profile-popover-data.md): Returns branch details, agent counts, and statistics for the popover card. **Required permission:** `api.agents.branch_profile_popover.manage`
- [Get branch sharing status](https://help.propops.app/api-reference/agents/get-branch-sharing-status.md): Returns whether the current agent's branch has sharing enabled. **Required permission:** `api.agents.branch_sharing`
- [List active agents](https://help.propops.app/api-reference/agents/list-active-agents.md): Retrieve active property agents for job assignment. **Required permission:** `api.agents.list.manage`
- [List agent branch assignments](https://help.propops.app/api-reference/agents/list-agent-branch-assignments.md): Retrieve branch assignments for agents. **Required permission:** `api.agents.branches.manage`
- [List branch SLA documents](https://help.propops.app/api-reference/agents/list-branch-sla-documents.md): Retrieve uploaded SLA documents for a branch. **Required permission:** `api.agents.branch_sla.manage`
- [List jobs for an agent's branch](https://help.propops.app/api-reference/agents/list-jobs-for-an-agents-branch.md): Retrieve all jobs associated with the branches managed by an agent. **Required permission:** `api.agents.branch-jobs.manage`
- [List SLA response time rules](https://help.propops.app/api-reference/agents/list-sla-response-time-rules.md): Retrieve configured SLA response time rules for a branch. **Required permission:** `api.agents.branch_sla_response_times.manage`
- [Toggle branch sharing](https://help.propops.app/api-reference/agents/toggle-branch-sharing.md): Enable or disable branch sharing for the current agent's branch. **Required permission:** `api.agents.branch_sharing`
- [Upload branch logo](https://help.propops.app/api-reference/agents/upload-branch-logo.md): Upload a new logo for a branch. **Required permission:** `api.agents.branch_logo.manage`
- [Upload SLA documents](https://help.propops.app/api-reference/agents/upload-sla-documents.md): Upload SLA document files for a branch. Accepts PDF, DOC, DOCX, and TXT files up to 10 MB each.
- [Branch performance metrics](https://help.propops.app/api-reference/analytics/branch-performance-metrics.md): Returns performance KPIs per branch including job completion rates and revenue. **Required permission:** `api.analytics.branch-performance.manage`
- [Filtered activity feed](https://help.propops.app/api-reference/analytics/filtered-activity-feed.md): Returns activity events filtered by type, user, or date range. **Required permission:** `api.analytics.filtered-activity.manage`
- [Job health check](https://help.propops.app/api-reference/analytics/job-health-check.md): Returns an overall health score and flags for the job pipeline. **Required permission:** `api.analytics.job-health-check.manage`
- [Recent platform activity](https://help.propops.app/api-reference/analytics/recent-platform-activity.md): Returns the most recent activity events across the platform. **Required permission:** `api.analytics.recent-activity.manage`
- [Track a page view](https://help.propops.app/api-reference/analytics/track-a-page-view.md): Record a page view event for analytics. **Required permission:** `api.analytics.page-tracking.manage`
- [Track a page view (simple)](https://help.propops.app/api-reference/analytics/track-a-page-view-simple.md): Record a lightweight page view event. Does not require CSRF. **Required permission:** `api.analytics.simple_page_tracking.manage`
- [Authenticate and get bearer token](https://help.propops.app/api-reference/authentication/authenticate-and-get-bearer-token.md): Authenticate with email and password to receive a long-lived bearer token for API access. Available on any domain. When used on the API Playground (`my.propops.app`), login is restricted to SysOps and API roles only.
- [Get jobs for calendar view](https://help.propops.app/api-reference/calendar/get-jobs-for-calendar-view.md): Returns jobs within a date range formatted for calendar display. **Required permission:** `api.calendar-jobs.manage`
- [Get contractor certification records](https://help.propops.app/api-reference/contractors/get-contractor-certification-records.md): Retrieve compliance certification records for a contractor. **Required permission:** `api.contractors.certification.manage`
- [List active contractors](https://help.propops.app/api-reference/contractors/list-active-contractors.md): Retrieve active contractors available for job assignment. **Required permission:** `api.contractors.list.manage`
- [List contractor trade categories](https://help.propops.app/api-reference/contractors/list-contractor-trade-categories.md): Retrieve all available contractor trade categories. **Required permission:** `api.contractors.trades.manage`
- [List contractors with coverage areas](https://help.propops.app/api-reference/contractors/list-contractors-with-coverage-areas.md): Retrieve contractors enriched with their geographic coverage information. **Required permission:** `api.contractors.list-with-coverage.manage`
- [Upload contractor certification](https://help.propops.app/api-reference/contractors/upload-contractor-certification.md): Upload a certification document for a contractor. **Required permission:** `api.contractors.certification.manage`
- [Active recall jobs](https://help.propops.app/api-reference/dashboard/active-recall-jobs.md): Returns jobs currently in recall status for dashboard display. **Required permission:** `api.dashboard.recall.manage`
- [Batch dashboard data](https://help.propops.app/api-reference/dashboard/batch-dashboard-data.md): Returns multiple dashboard data sets in a single request to reduce round-trips. **Required permission:** `api.dashboard.batch.manage`
- [Completed jobs chiplet data](https://help.propops.app/api-reference/dashboard/completed-jobs-chiplet-data.md): Returns recently completed jobs for dashboard display. **Required permission:** `api.dashboard.completed-jobs.manage`
- [Dashboard chart data](https://help.propops.app/api-reference/dashboard/dashboard-chart-data.md): Returns 7-day trend data for new jobs, accepted jobs, and overdue invoices. Filtered by account type. **Required permission:** `api.dashboard.charts.manage`
- [Dashboard chiplet counts](https://help.propops.app/api-reference/dashboard/dashboard-chiplet-counts.md): Returns badge counts for all dashboard chiplet tiles. **Required permission:** `api.dashboard.chiplets-count.manage`
- [Job counts grouped by type](https://help.propops.app/api-reference/dashboard/job-counts-grouped-by-type.md): Returns a breakdown of job counts per job type for chart display. **Required permission:** `api.dashboard.jobs-by-type.manage`
- [Jobs booked today](https://help.propops.app/api-reference/dashboard/jobs-booked-today.md): Returns jobs scheduled for today. **Required permission:** `api.dashboard.booked-today.manage`
- [Jobs with missing certificates](https://help.propops.app/api-reference/dashboard/jobs-with-missing-certificates.md): Returns jobs flagged as having missing compliance certificates. **Required permission:** `api.dashboard.missing-certs.manage`
- [Jobs without an assigned contractor](https://help.propops.app/api-reference/dashboard/jobs-without-an-assigned-contractor.md): Returns open jobs with no contractor assigned. **Required permission:** `api.dashboard.no-contractor.manage`
- [New jobs chiplet data](https://help.propops.app/api-reference/dashboard/new-jobs-chiplet-data.md): Returns recently created jobs for the dashboard new-jobs chiplet. **Required permission:** `api.dashboard.new-jobs.manage`
- [Overdue quotes](https://help.propops.app/api-reference/dashboard/overdue-quotes.md): Returns jobs with overdue outstanding quotes. **Required permission:** `api.dashboard.overdue-quotes.manage`
- [Pinned jobs](https://help.propops.app/api-reference/dashboard/pinned-jobs.md): Returns all jobs pinned by the current user. **Required permission:** `api.dashboard.pinned-jobs.manage`
- [Quick-update a job from the dashboard](https://help.propops.app/api-reference/dashboard/quick-update-a-job-from-the-dashboard.md): Update a job's status or completion date directly from the dashboard. **Required permission:** `api.dashboard.update_job.manage`
- [Retrieve dashboard statistics](https://help.propops.app/api-reference/dashboard/retrieve-dashboard-statistics.md): Returns aggregate job and activity statistics for the main dashboard sidebar. **Required permission:** `api.dashboard.stats.manage`
- [Security operations chiplet data](https://help.propops.app/api-reference/dashboard/security-operations-chiplet-data.md): Returns security metrics for the SecOps dashboard chiplets including failed logins, locked sessions, high-risk activity, file integrity alerts, and API abuse IPs. Includes today vs yesterday comparison with delta %.
- [Users with incomplete onboarding](https://help.propops.app/api-reference/dashboard/users-with-incomplete-onboarding.md): Returns users who have not completed onboarding. **Required permission:** `api.dashboard.incomplete-onboarding.manage`
- [List email templates](https://help.propops.app/api-reference/email/list-email-templates.md): Retrieve all available email templates. **Required permission:** `api.email.templates.manage`
- [Request email re-verification](https://help.propops.app/api-reference/email/request-email-re-verification.md): Trigger a fresh verification email for a user. **Required permission:** `api.email.verify.manage`
- [Send a transactional email](https://help.propops.app/api-reference/email/send-a-transactional-email.md): Send a transactional email via the Brevo integration using a configured template. **Required permission:** `api.email.send.manage`
- [Send welcome email](https://help.propops.app/api-reference/email/send-welcome-email.md): Send the onboarding welcome email to a newly created user. **Required permission:** `api.email.welcome.manage`
- [Verify an email address token](https://help.propops.app/api-reference/email/verify-an-email-address-token.md): Validates an email verification token sent to a user. **Required permission:** `api.email.verify.manage`
- [List invoices](https://help.propops.app/api-reference/financial/list-invoices.md): Retrieve invoices with optional payment status filtering. **Required permission:** `api.financial.invoices.manage`
- [Update invoice payment fields](https://help.propops.app/api-reference/financial/update-invoice-payment-fields.md): Update payment tracking fields (received, sent, commission). **Required permission:** `api.financial.invoices.manage`
- [Record GDPR consent](https://help.propops.app/api-reference/gdpr/record-gdpr-consent.md): Record a user's cookie/data consent choices. This is a public endpoint that does not require authentication (used on the login page).
- [Create a case note](https://help.propops.app/api-reference/jobs/create-a-case-note.md): Add a new case note to a job, optionally sending an email notification. **Required permission:** `api.jobs.case-notes.manage`
- [Create a recall record](https://help.propops.app/api-reference/jobs/create-a-recall-record.md): Flag a job as recalled. **Required permission:** `api.jobs.recall.manage`
- [Create or action an amendment request](https://help.propops.app/api-reference/jobs/create-or-action-an-amendment-request.md): Submit a new amendment request or approve/reject an existing one. **Required permission:** `api.jobs.amend-request.manage`
- [Create or remove a remedial link](https://help.propops.app/api-reference/jobs/create-or-remove-a-remedial-link.md): Link a job as a remedial of another, or remove an existing link. **Required permission:** `api.jobs.remedials.manage`
- [Create, update, or delete a job](https://help.propops.app/api-reference/jobs/create-update-or-delete-a-job.md): Perform write operations on jobs. The `action` field in the request body determines the operation: - `create` — Create a new job - `update` — Update an existing job (requires `uuid`) - `delete` — Permanently delete a job and all associated data (requires `uuid`) - `send_assignment_notification` — No…
- [Download an attachment by UUID](https://help.propops.app/api-reference/jobs/download-an-attachment-by-uuid.md): Serve a file attachment securely by its UUID. **Required permission:** Authenticated session with access to the associated resource.
- [Get a document thumbnail](https://help.propops.app/api-reference/jobs/get-a-document-thumbnail.md): Returns a JPEG thumbnail for a job document. Supports images, PDFs, and video files. Uses aggressive caching (1 year). Falls back to an SVG placeholder on error.
- [Get amendable fields for a job](https://help.propops.app/api-reference/jobs/get-amendable-fields-for-a-job.md): Returns which fields of a given job are eligible for amendment requests, with their current values. **Required permission:** `api.jobs.amendable-fields.manage`
- [Get video variants for a job media file](https://help.propops.app/api-reference/jobs/get-video-variants-for-a-job-media-file.md): Retrieve available resolution variants for adaptive video playback. **Required permission:** `api.jobs.video-variants.manage`
- [List amendment requests](https://help.propops.app/api-reference/jobs/list-amendment-requests.md): Retrieve pending or historical amendment requests for a job. **Required permission:** `api.jobs.amend-request.manage`
- [List case notes for a job](https://help.propops.app/api-reference/jobs/list-case-notes-for-a-job.md): Retrieve all case notes associated with a specific job. **Required permission:** `api.jobs.case-notes.manage`
- [List job payment statuses](https://help.propops.app/api-reference/jobs/list-job-payment-statuses.md): Retrieve payment status options for dropdown selection. **Required permission:** `api.jobs.payment-statuses.manage`
- [List job priorities](https://help.propops.app/api-reference/jobs/list-job-priorities.md): Retrieve all job priority levels. **Required permission:** `api.jobs.priorities.manage`
- [List job statuses](https://help.propops.app/api-reference/jobs/list-job-statuses.md): Retrieve all available job status options for dropdown population. **Required permission:** `api.jobs.statuses.manage`
- [List job time ranges](https://help.propops.app/api-reference/jobs/list-job-time-ranges.md): Retrieve available time range slots. **Required permission:** `api.jobs.time-ranges.manage`
- [List job types](https://help.propops.app/api-reference/jobs/list-job-types.md): Retrieve all job type categories. **Required permission:** `api.jobs.types.manage`
- [List or download case note attachments](https://help.propops.app/api-reference/jobs/list-or-download-case-note-attachments.md): Retrieve attachment metadata or download a specific attachment. **Required permission:** `api.jobs.case-note-attachments.manage`
- [List or download job documents](https://help.propops.app/api-reference/jobs/list-or-download-job-documents.md): Retrieve document metadata for a job or download a specific document. **Required permission:** `api.jobs.documents.manage`
- [List or download job photos](https://help.propops.app/api-reference/jobs/list-or-download-job-photos.md): Retrieve photo metadata or download a specific photo/thumbnail. **Required permission:** `api.jobs.photos.manage`
- [List or retrieve jobs](https://help.propops.app/api-reference/jobs/list-or-retrieve-jobs.md): Retrieve a paginated list of jobs or fetch a single job by UUID. Use `action=list` for paginated results or `action=get` with a `uuid` parameter for a specific job.
- [List recall records](https://help.propops.app/api-reference/jobs/list-recall-records.md): Retrieve recall records for a job. **Required permission:** `api.jobs.recall.manage`
- [List remedial links for a job](https://help.propops.app/api-reference/jobs/list-remedial-links-for-a-job.md): Retrieve remedial job relationships. **Required permission:** `api.jobs.remedials.manage`
- [Mark a recall as completed](https://help.propops.app/api-reference/jobs/mark-a-recall-as-completed.md): Mark a recall record as resolved/completed. **Required permission:** `api.jobs.mark-recall-completed.manage`
- [Search property addresses](https://help.propops.app/api-reference/jobs/search-property-addresses.md): Retrieve and search property addresses for job assignment. **Required permission:** `api.jobs.addresses.manage`
- [Toggle pin status of a job](https://help.propops.app/api-reference/jobs/toggle-pin-status-of-a-job.md): Pin or unpin a job on the dashboard. **Required permission:** `api.jobs.toggle-pin.manage`
- [Upload case note attachment](https://help.propops.app/api-reference/jobs/upload-case-note-attachment.md): Upload a file attachment to a case note. **Required permission:** `api.jobs.case-note-attachments.manage`
- [Upload or delete a job document](https://help.propops.app/api-reference/jobs/upload-or-delete-a-job-document.md): Upload a new document to a job or delete an existing one. **Required permission:** `api.jobs.documents.manage`
- [Upload or delete a job photo](https://help.propops.app/api-reference/jobs/upload-or-delete-a-job-photo.md): Upload photos (with auto-compression) or remove existing photos. **Required permission:** `api.jobs.photos.manage`
- [Create a notice](https://help.propops.app/api-reference/notices/create-a-notice.md): Create a new system notice for dashboard or login display. **Required permission:** `api.system.notices.manage`
- [Delete or dismiss a notice](https://help.propops.app/api-reference/notices/delete-or-dismiss-a-notice.md): Delete a notice or dismiss it for the current user. **Required permission:** `api.system.notices.manage`
- [List or retrieve notices](https://help.propops.app/api-reference/notices/list-or-retrieve-notices.md): Retrieve system notices for dashboard, login page, or management list.
- [Update a notice](https://help.propops.app/api-reference/notices/update-a-notice.md): Update an existing system notice. **Required permission:** `api.system.notices.manage`
- [Generate financial report](https://help.propops.app/api-reference/reports/generate-financial-report.md): Returns a financial summary report with optional search and date filters. **Required permission:** `api.reports.financial.manage`
- [Generate user activity report](https://help.propops.app/api-reference/reports/generate-user-activity-report.md): Returns a user activity summary report. **Required permission:** `api.reports.users.manage`
- [Global search](https://help.propops.app/api-reference/search/global-search.md): Searches across jobs, users, branches, contractors, and tenants based on the current user's permissions. Returns categorised results.
- [Check password against breach database](https://help.propops.app/api-reference/security/check-password-against-breach-database.md): Checks a password against the Have I Been Pwned breach database using the k-Anonymity model. Results are cached.
- [Get a CSRF token](https://help.propops.app/api-reference/security/get-a-csrf-token.md): Returns a fresh CSRF token for the current session. Include this token in all state-mutating requests as `csrf_token`.
- [List active sessions](https://help.propops.app/api-reference/security/list-active-sessions.md): Retrieve all currently active user sessions. **Required permission:** `api.security.sessions.list`
- [List file integrity alerts](https://help.propops.app/api-reference/security/list-file-integrity-alerts.md): Retrieve file integrity monitoring alerts. **Required permission:** `api.security.file-integrity.manage`
- [List file integrity monitoring alerts](https://help.propops.app/api-reference/security/list-file-integrity-monitoring-alerts.md): Returns paginated file integrity alerts with filtering by status and severity. **Required permission:** `api.security.file_integrity_alerts.manage`
- [Mark a file integrity alert as resolved](https://help.propops.app/api-reference/security/mark-a-file-integrity-alert-as-resolved.md): Resolve a flagged file integrity alert. **Required permission:** `api.security.file-integrity.manage`
- [Mobile app authentication](https://help.propops.app/api-reference/security/mobile-app-authentication.md): Authenticate a mobile app client by validating a token or logging out. Sessions created via this endpoint have a 365-day lifetime.
- [Resolve a file integrity alert](https://help.propops.app/api-reference/security/resolve-a-file-integrity-alert.md): Mark a file integrity alert as resolved with optional notes. **Required permission:** `api.security.resolve_alert.manage`
- [Terminate a session or manage blacklist](https://help.propops.app/api-reference/security/terminate-a-session-or-manage-blacklist.md): Perform session management actions: - `terminate` — End a specific user session (requires `api.security.sessions.terminate`) - `blacklist_add` — Add a user to the access blacklist - `blacklist_remove` — Remove a user from the blacklist
- [Trigger a file integrity scan](https://help.propops.app/api-reference/security/trigger-a-file-integrity-scan.md): Launches a background file integrity scan. Can run a full scan or target specific paths.
- [View file diff against source](https://help.propops.app/api-reference/security/view-file-diff-against-source.md): Compares a local file against its source version from GitHub. Returns a unified diff with SHA1 hashes and line counts.
- [Create, update, or delete a service price](https://help.propops.app/api-reference/services/create-update-or-delete-a-service-price.md): Manage service pricing entries. **Required permission:** `api.services.pricing.manage`
- [List service pricing](https://help.propops.app/api-reference/services/list-service-pricing.md): Retrieve configured service prices and categories. **Required permission:** `api.services.pricing.manage`
- [List SLA-breached jobs](https://help.propops.app/api-reference/sla/list-sla-breached-jobs.md): Returns jobs that have breached their SLA response time, grouped by branch, agent, and contractor. Filtered by the current user's account type.
- [Create or dismiss a system notification](https://help.propops.app/api-reference/system/create-or-dismiss-a-system-notification.md): Create a new system-wide notification or dismiss an existing one. **Required permission:** `api.system.notifications.manage`
- [Detailed system status](https://help.propops.app/api-reference/system/detailed-system-status.md): Returns a detailed status report including database, cache, and queue health. **Required permission:** `api.system.status.manage`
- [Get maintenance mode status](https://help.propops.app/api-reference/system/get-maintenance-mode-status.md): Returns whether the platform is in maintenance mode. This is a public endpoint that does not require authentication.
- [Get system settings and user management data](https://help.propops.app/api-reference/system/get-system-settings-and-user-management-data.md): Retrieve system settings or user management data for the admin panel.
- [Get web push configuration](https://help.propops.app/api-reference/system/get-web-push-configuration.md): Returns the VAPID public key and whether web push is enabled. **Required permission:** `api.system.web_push_subscriptions.manage`
- [List registered device tokens](https://help.propops.app/api-reference/system/list-registered-device-tokens.md): Retrieve push notification device tokens for the current user. **Required permission:** `api.system.device-tokens.manage`
- [List system notifications](https://help.propops.app/api-reference/system/list-system-notifications.md): Retrieve active system-wide notifications/notices. **Required permission:** `api.system.notifications.manage`
- [Perform system settings actions](https://help.propops.app/api-reference/system/perform-system-settings-actions.md): Perform user or system management actions: - `bulk_action` — Bulk user operations - `toggle_status` — Enable/disable a user - `update_user` — Update user details - `delete_user` — Remove a user - `logout_user` — Force logout
- [Register a web push subscription](https://help.propops.app/api-reference/system/register-a-web-push-subscription.md): Register a browser push notification subscription endpoint. **Required permission:** `api.system.web_push_subscriptions.manage`
- [Register or remove a device token](https://help.propops.app/api-reference/system/register-or-remove-a-device-token.md): Register a device for push notifications or remove an existing registration. **Required permission:** `api.system.device-tokens.manage`
- [Remove a web push subscription](https://help.propops.app/api-reference/system/remove-a-web-push-subscription.md): Unregister a browser push notification endpoint. **Required permission:** `api.system.web_push_subscriptions.manage`
- [Send a test web push notification](https://help.propops.app/api-reference/system/send-a-test-web-push-notification.md): Send a test push notification to all registered devices for the current user. **Required permission:** `api.system.web_push_test.send`
- [System heartbeat / health check](https://help.propops.app/api-reference/system/system-heartbeat-health-check.md): Returns platform operational status. This endpoint does not require authentication and is suitable for uptime monitors.
- [System-wide search](https://help.propops.app/api-reference/system/system-wide-search.md): Search across jobs, users, admin pages, and other system resources. Requires a minimum query length of 2 characters.
- [Toggle maintenance mode](https://help.propops.app/api-reference/system/toggle-maintenance-mode.md): Enable or disable maintenance mode with an optional reason. **Required permission:** `api.system.maintenance_mode.manage`
- [View application logs](https://help.propops.app/api-reference/system/view-application-logs.md): Retrieve application and system log entries. **Required permission:** `api.system.logs.read`
- [Assign an address to a tenant](https://help.propops.app/api-reference/tenants/assign-an-address-to-a-tenant.md): Link a property address to a tenant record. **Required permission:** `api.tenants.assign-address.manage`
- [Create a tenant](https://help.propops.app/api-reference/tenants/create-a-tenant.md): Add a new tenant record. **Required permission:** `api.tenants.list.manage`
- [Generate GDPR data report for a tenant](https://help.propops.app/api-reference/tenants/generate-gdpr-data-report-for-a-tenant.md): Returns all personally identifiable data held for a tenant for GDPR compliance. **Required permission:** `api.tenants.gdpr-report.manage`
- [Get tenant details](https://help.propops.app/api-reference/tenants/get-tenant-details.md): Retrieve full details for a tenant record. **Required permission:** `api.tenants.manage.manage`
- [List or retrieve tenants](https://help.propops.app/api-reference/tenants/list-or-retrieve-tenants.md): Retrieve tenants with optional filters, or fetch a specific tenant. **Required permission:** `api.tenants.list.manage`
- [Update or delete a tenant](https://help.propops.app/api-reference/tenants/update-or-delete-a-tenant.md): Update tenant information or delete a tenant record. **Required permission:** `api.tenants.manage.manage`
- [Activate or deactivate a user](https://help.propops.app/api-reference/users/activate-or-deactivate-a-user.md): Change a user's active/inactive status. **Required permission:** `api.users.user_status.view`
- [Create, update, or delete a user](https://help.propops.app/api-reference/users/create-update-or-delete-a-user.md): Manage user accounts. The `action` field controls the operation: - `create_user` — Create a new user account - `update` — Update user details - `delete_user` — Delete a user account - `toggle_status` — Enable or disable a user - `update_role` — Assign a different role - `terminate_session` — End a s…
- [Force-logout a user](https://help.propops.app/api-reference/users/force-logout-a-user.md): Terminate all sessions for a specific user. Cannot be used to log out yourself. **Required permission:** `api.users.logout_user.manage`
- [Get dashboard widget preferences](https://help.propops.app/api-reference/users/get-dashboard-widget-preferences.md): Retrieve the current user's dashboard widget visibility and ordering. **Required permission:** `api.users.dashboard_widget_preferences.manage`
- [Get notification settings](https://help.propops.app/api-reference/users/get-notification-settings.md): Retrieve notification preferences for the current user. **Required permission:** `api.users.notification-settings.manage`
- [Get online users](https://help.propops.app/api-reference/users/get-online-users.md): Returns a list of users who have been active in the last 30 minutes. **Required permission:** `api.users.user_status.view`
- [Get user appearance settings](https://help.propops.app/api-reference/users/get-user-appearance-settings.md): Retrieve appearance/dashboard customisation settings for a user. **Required permission:** `api.users.appearance.manage`
- [Get user permissions](https://help.propops.app/api-reference/users/get-user-permissions.md): Retrieve the permissions assigned to a specific user. **Required permission:** `api.users.permissions.manage`
- [Get user profile popover data](https://help.propops.app/api-reference/users/get-user-profile-popover-data.md): Returns user details, account type, branch info, and activity stats for the popover card. **Required permission:** `api.users.user_profile_popover.manage`
- [List or retrieve users](https://help.propops.app/api-reference/users/list-or-retrieve-users.md): Retrieve users with optional filters, or fetch a specific user.
- [Request or complete a password reset](https://help.propops.app/api-reference/users/request-or-complete-a-password-reset.md): Two-step password reset flow: - `request` — Send a reset link to the user's email address - `reset` — Submit a new password with the reset token
- [Retrieve user avatar](https://help.propops.app/api-reference/users/retrieve-user-avatar.md): Fetch the avatar image for a user. **Required permission:** `api.users.avatar.manage`
- [Send email verification](https://help.propops.app/api-reference/users/send-email-verification.md): Trigger an email verification link for a user account. **Required permission:** `api.users.email-verification.manage`
- [Update appearance settings or upload banner](https://help.propops.app/api-reference/users/update-appearance-settings-or-upload-banner.md): Update dashboard appearance settings or upload a custom banner image.
- [Update dashboard widget preferences](https://help.propops.app/api-reference/users/update-dashboard-widget-preferences.md): Save the user's dashboard widget layout and visibility settings. **Required permission:** `api.users.dashboard_widget_preferences.manage`
- [Update notification settings](https://help.propops.app/api-reference/users/update-notification-settings.md): Update notification channel preferences. **Required permission:** `api.users.notification-settings.manage`
- [Update user permissions](https://help.propops.app/api-reference/users/update-user-permissions.md): Grant or revoke specific permissions for a user. **Required permission:** `api.users.permissions.manage`
- [Upload or delete user avatar](https://help.propops.app/api-reference/users/upload-or-delete-user-avatar.md): Upload a new avatar image for a user account. **Required permission:** `api.users.avatar.manage`
- [Get weather forecast](https://help.propops.app/api-reference/weather/get-weather-forecast.md): Returns weather forecast data for a given location and date range via the Open-Meteo integration. Results are cached for one hour.
- [List or retrieve n8n workflows](https://help.propops.app/api-reference/webhooks/list-or-retrieve-n8n-workflows.md): Retrieve workflow data from the connected n8n instance including execution history and statistics.
- [Trigger, toggle, or test a workflow](https://help.propops.app/api-reference/webhooks/trigger-toggle-or-test-a-workflow.md): Perform actions on n8n workflows: - `trigger` — Manually trigger a workflow - `toggle` — Enable or disable a workflow - `test` — Run a test execution
- [Get WhatsApp send options for a job](https://help.propops.app/api-reference/whatsapp/get-whatsapp-send-options-for-a-job.md): Returns available phone numbers, message templates, and the default template for sending WhatsApp messages related to a job.
- [Send a WhatsApp message](https://help.propops.app/api-reference/whatsapp/send-a-whatsapp-message.md): Send a WhatsApp message to a contact using a pre-configured template. Rate limited to 20 messages per minute.
- [Authentication](https://help.propops.app/api/authentication.md): Authenticate with the PropOps API using session cookies, Bearer tokens, or CSRF tokens — and understand how permissions are enforced.
- [Error handling](https://help.propops.app/api/errors.md): HTTP status codes returned by the PropOps API, what each code means, common causes, and how to handle errors in your integration code.
- [API Overview](https://help.propops.app/api/overview.md): Base URL, JSON response format, pagination, rate limiting, authentication methods, and the full list of resource groups for the PropOps API.
- [Changelog](https://help.propops.app/changelog/overview.md): A chronological record of significant improvements, new features, bug fixes, and platform hardening delivered to PropOps Web.
- [Branches](https://help.propops.app/configuration/branches.md): Create and manage branch locations, assign staff, configure SLA targets, set sharing rules, and view branch performance analytics.
- [Integrations](https://help.propops.app/configuration/integrations.md): Connect PropOps to n8n workflow automation, WhatsApp messaging, Brevo email, Mapbox, and web push notifications from the admin panel.
- [Settings](https://help.propops.app/configuration/settings.md): Configure branding, notifications, permissions, job tags, document templates, WhatsApp messages, rate limits, and VAT from the admin panel.
- [Admin Panel](https://help.propops.app/features/admin.md): System administration tools — environment configuration, cron management, API health monitoring, activity logs, and security tools.
- [Calendar](https://help.propops.app/features/calendar.md): View and manage jobs on an interactive calendar with month, week, and day views — filter by branch, contractor, agent, and job type.
- [Contractors](https://help.propops.app/features/contractors.md): Manage contractor profiles, track trade certifications, and use the interactive coverage map to find the right contractor for every job.
- [Coverage Map](https://help.propops.app/features/coverage-map.md): Interactive contractor coverage map powered by Mapbox — visualise travel-time radii, search by postcode, and overlay nearby points of interest.
- [Cron Jobs](https://help.propops.app/features/cron-jobs.md): Background automation in PropOps Web using scheduled cron scripts, n8n orchestration, secure webhook triggering, and audit logging.
- [Email System](https://help.propops.app/features/email.md): Automatic branded email notifications for jobs, users, payments, security alerts, and more in PropOps Web.
- [Financial](https://help.propops.app/features/financial.md): Create and manage invoices, record payments, track payment status per maintenance job, and generate financial reports in PropOps.
- [Job Management](https://help.propops.app/features/job-management.md): Create, assign, track, and close maintenance jobs with SLA enforcement, approval gates, case notes, and document management.
- [Multi-Tenancy](https://help.propops.app/features/multi-tenancy.md): Fully isolated data per tenant organisation with per-tenant configuration, feature flags, and custom branding.
- [Notifications](https://help.propops.app/features/notifications.md): Stay informed through in-app alerts, email, push notifications, and WhatsApp — with per-user preferences to control what you receive and how.
- [Progressive Web App](https://help.propops.app/features/pwa.md): Install PropOps on desktop and mobile as a native-like app with offline caching and home-screen support.
- [Tenants & Landlords](https://help.propops.app/features/tenants-landlords.md): Manage tenant and landlord records, control what each party can see, and fulfil GDPR right-of-access requests with a single export.
- [Users & Accounts](https://help.propops.app/features/users-accounts.md): Three account types with role-based access control, guided onboarding, password breach monitoring, and session management.
- [WhatsApp](https://help.propops.app/features/whatsapp.md): Send pre-filled WhatsApp messages to contractors and tenants using configurable templates — no WhatsApp Business API required.
- [Brand Management](https://help.propops.app/guides/brand-management.md): Customise your PropOps instance with your organisation's colours, logo, and identity so the platform feels like your own.
- [Cron Job Management](https://help.propops.app/guides/cron-job-management.md): Set up and operate PropOps Web background jobs with n8n, secure webhook calls, retention controls, and audit verification.
- [Email Configuration](https://help.propops.app/guides/email-configuration.md): Set up email delivery, configure Brevo, customise templates, and manage environment variables in PropOps Web.
- [Email System](https://help.propops.app/guides/email-system.md): View the email log, check delivery status, and troubleshoot email issues in PropOps Web.
- [Financial Workflows](https://help.propops.app/guides/financial-workflows.md): Raise invoices, record payments, reconcile balances, and generate financial reports in PropOps — including VAT handling and Xero sync.
- [Managing Contractors](https://help.propops.app/guides/managing-contractors.md): Add contractor profiles, upload trade certifications, use the interactive coverage map, and assign the best-matched contractor to each job.
- [Multi-Tenancy Setup](https://help.propops.app/guides/multi-tenancy-setup.md): Configure organisations, isolate data, apply custom branding, and manage feature flags per tenant.
- [Reports & Analytics](https://help.propops.app/guides/reports-and-analytics.md): Use the PropOps dashboard, run financial and user activity reports, and understand how branch performance scoring works.
- [Setting Up Notifications](https://help.propops.app/guides/setting-up-notifications.md): Configure in-app, email, push, and WhatsApp notifications for staff, agents, and contractors — with per-user preference controls.
- [Settings & Configuration](https://help.propops.app/guides/settings-and-configuration.md): Configure branches, branding, third-party integrations, and organisation-wide settings in the PropOps admin panel to match your workflow.
- [Tenants & Landlords](https://help.propops.app/guides/tenants-and-landlords.md): Create tenant and landlord records in PropOps, link them to maintenance jobs, and handle GDPR subject access requests and data exports.
- [User Management](https://help.propops.app/guides/user-management.md): Create user accounts, assign staff roles, configure granular permissions, and use admin impersonation to troubleshoot access issues.
- [Using the Calendar](https://help.propops.app/guides/using-the-calendar.md): Navigate the job calendar, switch between views, apply filters, and jump to job details.
- [Using the Coverage Map](https://help.propops.app/guides/using-the-coverage-map.md): Search for contractors by location, view travel-time coverage, and toggle point-of-interest overlays.
- [Viewing Logs & Security Reports](https://help.propops.app/guides/viewing-logs.md): Step-by-step guide to finding and reading each log type available to administrators in PropOps Web.
- [WhatsApp Messaging](https://help.propops.app/guides/whatsapp-messaging.md): Send pre-filled WhatsApp messages to contractors and tenants using configurable templates.
- [Your First Job](https://help.propops.app/guides/your-first-job.md): Step-by-step walkthrough for creating your first maintenance job in PropOps Web — from raising a report through to completion and sign-off.
- [Configuration](https://help.propops.app/installation/configuration.md): Configure your PropOps environment, set up HTTPS with a reverse proxy, secure your firewall, and complete first-time setup.
- [Docker Setup](https://help.propops.app/installation/docker-setup.md): Install PropOps using Docker Compose — start the containers and have a working system in minutes.
- [Management](https://help.propops.app/installation/management.md): Manage, upgrade, back up, and troubleshoot your PropOps Docker deployment.
- [Server Requirements](https://help.propops.app/installation/requirements.md): Minimum server specifications and how to check your VPS or server supports Docker before installing PropOps.
- [Introduction](https://help.propops.app/introduction.md): PropOps Web is the UK enterprise property maintenance platform — connecting jobs, contractors, agents, landlords, and tenants in one system.
- [Acceptable Use Policy](https://help.propops.app/legal/acceptable-use.md): Acceptable use rules for PropOps products — prohibited activities, security responsibilities, and the consequences of policy violations.
- [Cookie Policy](https://help.propops.app/legal/cookie-policy.md): How PropOps products use cookies, local storage, and similar tracking technologies — including what data is collected and how to manage preferences.
- [Data Processing Agreement](https://help.propops.app/legal/data-processing-agreement.md): Data processing agreement defining PropOps and customer responsibilities for personal data handling, sub-processors, and breach notification.
- [Disclaimer](https://help.propops.app/legal/disclaimer.md): General disclaimers and limitations of liability for PropOps products, including warranty exclusions and indemnification provisions.
- [GDPR Statement](https://help.propops.app/legal/gdpr-statement.md): How PropOps products comply with the UK General Data Protection Regulation — covering lawful basis, data subject rights, and processor obligations.
- [Licence Terms](https://help.propops.app/legal/licence-terms.md): Licence terms governing the purchase, permitted use, restrictions, and intellectual property provisions of PropOps software products.
- [Making Tax Digital](https://help.propops.app/legal/making-tax-digital.md): How PropOps Web supports HMRC Making Tax Digital compliance through its Xero integration for VAT returns, invoicing, and digital record keeping.
- [Open Source Notices](https://help.propops.app/legal/open-source-notices.md): Acknowledgements and licence attributions for the open source libraries, frameworks, and dependencies used in the PropOps Web application.
- [Privacy Policy](https://help.propops.app/legal/privacy-policy.md): How PropOps collects, uses, stores, and protects your personal data — including cookies, third-party sharing, retention periods, and your rights.
- [Service Level Agreement](https://help.propops.app/legal/sla.md): PropOps service level agreement covering uptime commitments, support response times, severity classifications, and available remedies.
- [Software Supply Chain Transparency](https://help.propops.app/legal/supply-chain-transparency.md): How PropOps Technologies Ltd builds, verifies, and distributes PropOps Web — covering source control, build pipelines, container attestation, dependency management, and artifact integrity.
- [Terms of Service](https://help.propops.app/legal/terms-of-service.md): Read the terms and conditions that govern your use of PropOps products, including account responsibilities, acceptable use, and liability limits.
- [Third-Party Trademarks](https://help.propops.app/legal/third-party-trademarks.md): Trademark attributions and disclaimers for third-party names, logos, and brands referenced within PropOps products and documentation.
- [API Permissions](https://help.propops.app/permissions/api-permissions.md): Complete reference of all api.* permission keys in PropOps — controls which REST API endpoints and server-side operations each role can call.
- [Document Permissions](https://help.propops.app/permissions/document-permissions.md): Complete reference of document.* permission keys in PropOps — controls upload, read, and delete access for each document type on a job.
- [Notification Permissions](https://help.propops.app/permissions/notification-permissions.md): Complete reference of notifications.* permission keys in PropOps — controls which email, push, and in-app notification categories a user receives.
- [Page Permissions](https://help.propops.app/permissions/page-permissions.md): Complete reference of all page.* permission keys in PropOps — controls which dashboard pages and UI elements each staff role can access.
- [Permissions Template](https://help.propops.app/permissions/permissions-template.md): Download the default PropOps permissions template and explore every permission key across page, API, document, and notification categories.
- [Default Roles](https://help.propops.app/permissions/roles.md): Five built-in staff roles — SysOps, Director, Finance, Maintenance Coordinator, and Minimal Access — each with pre-configured permissions.
- [Quick Start](https://help.propops.app/quickstart.md): Get started with PropOps Web in minutes — log in, complete onboarding, configure your first branch, and create your first maintenance job.
- [Audit Log Reference](https://help.propops.app/security/audit-log.md): A complete reference covering every log table in PropOps Web — what is recorded, why it is recorded, and which data is encrypted at rest.
- [Authentication](https://help.propops.app/security/authentication.md): Sign in to PropOps securely, understand the login security checks including two-factor prompts, and manage your active browser sessions.
- [GDPR & Data Privacy](https://help.propops.app/security/gdpr.md): How PropOps Web supports UK GDPR compliance — what personal data is collected, how consent is recorded, and how to export or manage tenant data.
- [Security Overview](https://help.propops.app/security/overview.md): Learn how PropOps protects your property data with encryption, authentication controls, audit monitoring, and UK-based data residency.

## OpenAPI Specs

- [openapi](https://help.propops.app/openapi.yaml)