Developer tools

PropServ External API

A RESTful JSON API for estate agents. Pull work requests, contractor responses, tenant reports, tenants and users into your own systems — and raise new work requests without leaving your CRM.

Get your API tokenJump to the reference
Bearer token authenticationLive marketplace dataInteractive reference

Getting started

Up and running in four steps

Reading your agency's data works out of the box on the Ultimate plan. Writing to PropServ takes one extra step.

  1. Create an API token

    An admin user on your account can create tokens in the agent portal under Profile → API. Tokens belong to your company, so one token covers your whole agency.

  2. Choose its permissions

    Every token can read your agency's data. If you plan to create work requests through the API, also grant the token the write:submissions permission when you create it.

  3. Request write access

    Creating work requests is enabled per company and is not granted automatically. Ask your PropServ account manager, or email info@propserv.co, to have it switched on. Skip this step if you only need read access.

  4. Make your first request

    Send your token as a Bearer token in the Authorization header. Every response is JSON, and list endpoints are paginated.

Your first request

cURL
curl "https://api.propserv.co/api/external/submissions" \
  -H "Authorization: Bearer YOUR_COMPANY_API_TOKEN" \
  -H "Accept: application/json"

Write access is granted on request

Creating work requests via POST /external/submissions is switched on per company — it is not enabled automatically. All read endpoints work for every estate agent company on the Ultimate plan.

Request write access

Environments

Base URLs

All endpoints in the reference below are relative to these base URLs.

ProductionLive

https://api.propserv.co/api

DevelopmentTesting

https://dev.propfees.co/api

Contact us for development credentials.

What's available

Everything your agency sees, over JSON

Six resource groups cover the full PropServ workflow — from the moment a tenant reports an issue to the contractor quote you accept.

Work requests

Read every work request your agency has raised — and create new ones straight from your own system.

  • GET/external/submissions
  • GET/external/submissions/{uuid}
  • GET/external/submissions/{uuid}/responses
  • POST/external/submissionsOn request

Contractor responses

Quotes, callouts and declines from contractors, with pricing, documents and status history.

  • GET/external/submission-responses
  • GET/external/submission-responses/{uuid}

Tenant reports

Issues reported by tenants, including triage answers, categories and attached media.

  • GET/external/tenant-reports
  • GET/external/tenant-reports/{uuid}

Tenants & users

The people on your account — tenants linked to your agency and the users in your company.

  • GET/external/tenants
  • GET/external/users
  • GET/external/users/{uuid}

Reference data

Categories and properties — everything you need to build a valid work request payload.

  • GET/external/categories
  • GET/external/properties

Token management

Create, list and revoke company API tokens. Uses your own PropServ login, not a company token.

  • GET/api/external-api/tokens
  • POST/api/external-api/tokens
  • DELETE/api/external-api/tokens/{tokenId}

API reference

Explore every endpoint

The full OpenAPI reference — request parameters, payload schemas and example responses for every endpoint, including work request creation.

PropServ External API · OpenAPI 3.0Download the spec