Getting started

You need a BOX user that belongs to the branches you will raise work against. Getting access explains how to ask for pre-production credentials.

Base URL

https://pre-prod.lettingshub.co.uk/webapi/v2

Paths in this documentation are relative to that prefix. Do not repeat /webapi/v2 in the path.

Authenticate

POST /Authenticate returns the session token in a response header named Token, not in the JSON body. TokenExpiry is 720 (12 hours, in minutes). A new login by the same user retires the previous token, so authenticate once and reuse the token until it expires.

curl -i https://pre-prod.lettingshub.co.uk/webapi/v2/Authenticate \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "you@agency.example",
  "password": "your-password"
}'

Example request. A 200 response includes headers Token and TokenExpiry.

Send it on later requests as header Token:

curl https://pre-prod.lettingshub.co.uk/webapi/v2/Branches \
  -H 'Token: 7e99a076-40e8-4389-b17c-7f88bf91a247'

Example: list branches for the authenticated user. Keep the branch Id for later calls. See Identifiers for what to persist.

sequenceDiagram
  autonumber
  actor CRM
  participant API as Lettings Hub
  CRM->>API: POST /Authenticate
  API-->>CRM: 200, token and tokenExpiry headers
  CRM->>API: GET /Branches
  API-->>CRM: 200, branch list
        

Authentication and branch lookup.

Next

Create a tenancy and start referencing, then webhooks. Persist the ids listed under Identifiers. Operation schemas are in the API reference.