> ## Documentation Index
> Fetch the complete documentation index at: https://help.propops.app/llms.txt
> Use this file to discover all available pages before exploring further.
# API Overview
> Base URL, JSON response format, pagination, rate limiting, authentication methods, and the full list of resource groups for the PropOps API.
The PropOps REST API gives you programmatic access to every resource on the platform — jobs, contractors, tenants, users, finances, and more. All endpoints are under `/api/` on your PropOps instance URL.
```text theme={null}
https://propops.yourcompany.com/api/
```
State-changing requests (POST, PUT, DELETE) require a valid CSRF token in addition to authentication. See [Authentication](/api/authentication) for how to obtain and send one.
***
## Response format
Every response — success or error — is JSON. Successful responses use this envelope:
```json Success theme={null}
{
"success": true,
"data": { ... },
"count": 42,
"message": "Operation completed successfully"
}
```
```json Error theme={null}
{
"success": false,
"error": "Human-readable error message"
}
```
`count` is included on list endpoints and reflects the number of records in `data`. See [Error handling](/api/errors) for the full list of error codes.
***
## Pagination
List endpoints accept two query parameters:
Maximum number of records to return. Accepted range: 1–200.
Number of records to skip before returning results. Use with `limit` to page through large result sets.
```bash Example — second page of 25 jobs theme={null}
GET /api/jobs/manage?limit=25&offset=25
```
***
## Rate limiting
Requests are rate-limited per IP address and per authenticated account. When you exceed your limit the API returns `429 Too Many Requests`. Check the `Retry-After` header to know how long to wait before retrying.
Every response includes these rate-limit headers:
| Header | Description |
| ----------------------- | ------------------------------------------------- |
| `X-RateLimit-Limit` | Total requests allowed in the current window |
| `X-RateLimit-Remaining` | Requests remaining before the limit is hit |
| `X-RateLimit-Reset` | Unix timestamp when the window resets |
| `Retry-After` | Seconds to wait (only present on `429` responses) |
Administrators can view and adjust per-endpoint rate-limit rules in **Settings → API Monitoring**.
***
## Performance headers
Every API response includes timing headers so you can monitor integration performance:
| Header | Description |
| -------------------- | ------------------------------------------------------- |
| `X-Response-Time-ms` | Total time (ms) to process the request server-side |
| `X-DB-Query-Time-ms` | Time (ms) spent on database queries within that request |
***
## Resource groups
Create, update, and manage the full job lifecycle — including case notes, photos, documents, approvals, amendments, recalls, and calendar scheduling.
Manage user profiles, permissions, notification preferences, avatars, and active sessions.
List contractors, browse trade categories, and manage certifications.
Create and manage tenant records, assign addresses, and export GDPR data reports.
Retrieve agents, branch assignments, SLA profiles, and sharing rules.
Aggregate stats, charts, job feeds, pinned jobs, and batch data loading for the dashboard.
Activity feeds, branch performance, financial reports, and user contribution reports.
Create and manage invoices, record payments, track payment status, and service pricing.
Retrieve, mark as read, and delete in-app notifications and system notices.
Send transactional emails, manage templates, and verify email addresses.
Send pre-filled WhatsApp messages to tenants and contractors using configurable templates.
Full-text search across jobs, users, branches, and settings.
Manage sessions, CSRF tokens, file integrity alerts, password breach checks, and password resets.
Consent management and data subject access requests.
Health checks, maintenance mode, application settings, logs, and push subscriptions.
Manage branches, roles, permissions, activity logs, email logs, and API usage stats.
List, trigger, and monitor n8n workflow automations and subscribe to platform events.
Download and serve file attachments for jobs, case notes, and documents.