canonical: https://jentic.com/apis/helpthemove.co.uk/helpthemove

# Help The Move Partner API

The Help The Move Partner API is the integration surface for letting agencies operating on the Help The Move platform, exposing their branches, landlords, properties, and tenant moves as JSON resources. Agencies can list and create branches, manage landlord records, register properties against a landlord, and record tenant move-ins, move-outs, and meter readings. Every request is authenticated with a partner API token sent as a bearer value in the Authorization header, and the same contract is served across each white-label partner host.

## For AI agents

Manage a letting agency's branches, landlord records, properties, and tenant moves on the Help The Move platform, including move-ins, move-outs, and meter readings.

## Scope

Does not handle rent collection, payments, tenancy contracts, or referencing checks. Use for managing branches, landlords, properties, and tenant moves on the Help The Move platform only.

## Capabilities

- List and create branches within a partner account
- Create, retrieve, and update landlord records
- Register properties against a landlord and retrieve property details
- Record tenant move-ins and move-outs for a property
- Read and submit meter readings for a move
- List and cancel scheduled moves

## Use cases

### Agent-Assisted Landlord and Property Onboarding

An AI agent onboarding a new client for a letting agency creates the landlord record, then registers their properties against it through the Help The Move Partner API. Through Jentic the agent completes the multi-step setup, creating the landlord and adding the property, without a developer wiring each partner endpoint by hand.

Example prompt: Create a landlord under a branch and register a property against that landlord

### Tenant Move-In and Move-Out Processing

When a tenancy starts or ends, an agent records the move and its meter readings. The Help The Move Partner API exposes move-in, move-out, and meter-read operations per property and move, so an agent can log a move and submit the opening or closing meter readings in one flow.

Example prompt: Record a tenant move-out for a property and submit the closing meter readings

### Landlord and Property Portfolio Sync

A back-office system keeps its own copy of an agency's branches, landlords, and properties up to date. The Help The Move Partner API lists branches, landlords, and properties with their details, so an agent can pull the current portfolio and reconcile it against internal records.

Example prompt: List all properties for a branch and reconcile them against the internal records

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/partner/branches` | List branches |
| POST | `/partner/branches/{branchId}/landlords` | Create a landlord under a branch |
| GET | `/partner/landlords/{landlordId}` | Get a landlord by ID |
| PATCH | `/partner/landlords/{landlordId}` | Update a landlord |
| POST | `/partner/landlords/{landlordId}/properties` | Register a property against a landlord |
| POST | `/partner/properties/{propertyId}/move_ins` | Record a tenant move-in |
| POST | `/partner/properties/{propertyId}/move_outs` | Record a tenant move-out |
| PUT | `/partner/moves/{moveId}/meter_reads` | Submit meter readings for a move |

## Key resources

- **Branches** — List and create branches and read the meter-read requirements for a branch
- **Landlords** — Create, retrieve, and update landlord records within a branch
- **Properties** — Register properties against a landlord and retrieve property details
- **Moves** — Record tenant move-ins and move-outs and manage meter readings

## Why Jentic

- **Setup:** Wiring Help The Move by hand means obtaining a partner API token, sending it as a bearer value in the Authorization header on every call, and mapping the branch, landlord, property, and move endpoints yourself. Through Jentic you install once, import the API from the Directory, store the token once, and your agent calls it.
- **Permission scoping:** Landlords, properties, and moves are addressed by ID in the URL path (`/partner/landlords/{landlordId}`), so a rule can pin your agent to a specific record. You choose the operations it may call, so it can read the portfolio without being able to delete a move or update a landlord.
- **Credential handling:** Your partner API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a help the move landlord' or 'record a tenant move-out', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint.

## Related APIs

- **Your.Rentals API** — Your.Rentals manages rental property listings and bookings across channels, an alternative for agencies focused on marketing lettings rather than partner move workflows.
- **PropertyInspect API** — PropertyInspect handles property inspections and reports, pairing with Help The Move when an agent also needs inspection records for a tenancy.
- **RentCast API** — RentCast supplies rental market and property valuation data, useful alongside Help The Move for pricing a property the agency manages.

## FAQ

### What authentication does the Help The Move Partner API use?

The Help The Move Partner API authenticates with a partner API token sent as a bearer value in the Authorization header, in the format 'Bearer {token}', per its OpenAPI spec. Every operation requires it. Through Jentic the token is stored encrypted by your own Jentic One instance and injected when your agent calls the API.

### Is there a Help The Move MCP server?

You don't need an MCP server to give your agent the Help The Move Partner API. Jentic connects it directly from the API Directory: import it, store your partner token once, and your agent manages landlords, properties, and moves as it needs to. Nothing extra is loaded into the agent's context until a call is made.

### Can I limit what my agent is allowed to do with the Help The Move Partner API?

Yes. You choose which operations your agent may call, so you can allow read operations like listing landlords and properties while withholding the ones that create moves or delete records. Every call it makes is logged for review.

### Can I record a tenant move-out through the Help The Move Partner API?

Yes. The API has a move-out operation on a property and a meter-reads operation on the resulting move, so an agent can log the move-out and submit the closing meter readings.

### How do I manage landlords through Jentic?

Search Jentic for 'create a help the move landlord', which returns the landlord operation with its input schema. Add the Help The Move Partner API from the Jentic API Directory, store your partner token once, and your agent can manage landlords and properties. To run it on your own infrastructure, install Jentic One from its GitHub repo.
