Goodlord Referencing API
Goodlord's public Referencing API — the production surface of the Referencing Product listed in the public catalogue of the Goodlord Developer Portal. It lets a lettings agency's own system create rental applications, add and assess Applicants and Guarantors (plus Employer, Accountant and Landlord referees) through the referencing process, patch outcome conditions, read touchpoints and emails, and retrieve generated documents. Authentication is OAuth 2.0 machine-to-machine client_credentials against /auth/token, returning a one-hour JWT bearer token; every call additionally carries an issued Company-ID header. Three webhook events are documented (V2.subject.report.generated, V2.subject.reference.form.generated, V2.subject.outcome.updated) but subscriptions are configured by Goodlord on request, not self-serve. The OpenAPI 3.1.0 document was fetched anonymously; credentials are issued only through a Goodlord account manager.
Goodlord Referencing API is one of 3 APIs that Goodlord publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Referencing, Tenant Screening, Application, Lettings, and Rentals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 15 operations across 10 paths, organized into 4 resource areas, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://api.goodoverlord.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Goodlord Referencing API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.
By default, every request must be authenticated.
OAuth2— This API uses OAuth2 to authenticate requests. You must use your client credentials to obtain a token. Read [Obtain a JWT Token](./operations/getAuthToken) for…
Paths & Operations 15
Across 10 paths, the API surfaces 15 operations — 2 DELETE, 6 GET, 3 PATCH, 3 POST, 1 PUT. They span 4 resource areas: Authentication, Application, Subject, Media. Each is listed below with its method, path, parameters, and response codes.
Authentication operations
An application contains rental information and all of the applicants/guarantors which are applying for a tenancy.
A person who exists on an application.
Operations which are concerned around retrieving files
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Subject (9 properties), APITouchpoint (6 properties), Application (5 properties), CreateSubjectRequest (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Goodlord 2
Other APIs Goodlord publishes across the network.
This is an independent, third-party profile of Goodlord Referencing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.