Goodlord

aid: goodlord
url: https://raw.githubusercontent.com/api-evangelist/goodlord/refs/heads/main/apis.yml
name: Goodlord
kind: company
description: 'Goodlord (Oh Goodlord Limited, London) is a United Kingdom PropTech platform that digitises the pre-tenancy
  and tenancy lifecycle for residential letting agents, landlords and tenants — tenant referencing, e-signed tenancy contracts,
  rent and deposit payments, rent protection insurance, guarantors, PEPs and sanctions checks, inventories, utility switching
  and end-of-tenancy. It sits in the middle of the UK rental value chain, between the agency CRM (Reapit, Alto, Street, Qube)
  and the regulated deposit schemes, insurers and utility suppliers, rather than on the listings side controlled by the Rightmove/Zoopla
  portal duopoly. Its API posture is unusually open for the UK sector but is honestly split in two — the documentation is
  genuinely public and the machine-readable contracts are downloadable without a login from a Tyk-powered developer portal
  at portal.goodlord.co, yet credentials are not self-serve: the portal''s own registration page returns "Registration is
  not allowed" and requires an invite code, and Goodlord''s own getting-started guide instructs developers to obtain sandbox
  and production access through a Goodlord sales manager or account manager. Public contract, partner-gated keys. There is
  no RESO reference of any kind — RESO is a US NAR/MLS construct with no United Kingdom counterpart — and Goodlord publishes
  no open data.'
image: https://www.goodlord.com/hubfs/goodlord-logo-1.jpg
tags:
- Real Estate
- United Kingdom
- PropTech
- Property Management
- Rentals
- Lettings
- Tenant Referencing
- Tenancy Management
- Insurance
- Payments
created: '2026-07-26'
modified: '2026-07-26'
specificationVersion: '0.19'
apis:
- aid: goodlord:goodlord-referencing-api
  name: Goodlord Referencing API
  description: 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.
  humanURL: https://portal.goodlord.co/portal/catalogue-products/referencing-product-1
  baseURL: https://api.goodoverlord.com
  tags:
  - Referencing
  - Tenant Screening
  - Applications
  - Lettings
  - Rentals
  properties:
  - type: OpenAPI
    url: openapi/goodlord-referencing-api-openapi.json
  - type: Documentation
    url: https://portal.goodlord.co/portal/catalogue-products/referencing-product-1
  - type: APIReference
    url: https://portal.goodlord.co/portal/catalogue-products/referencing-product-1/dHlrL3Byb2QtcmVmZXJlbmNpbmctYXBp/docs
  - type: GettingStarted
    url: https://portal.goodlord.co/blog/2024/8/22/getting-started-with-goodlords-referencing-api
  - type: Documentation
    url: https://portal.goodlord.co/blog/2024/8/20/getting-started-with-goodlord-referencing-api
  - type: Overlay
    url: overlays/goodlord-referencing-api-overlay.yaml
  - type: Webhooks
    url: asyncapi/goodlord-referencing-webhooks.yml
- aid: goodlord:goodlord-referencing-api-sandbox
  name: Goodlord Referencing API (Sandbox)
  description: The sandbox environment of the Goodlord Referencing Product, published as a separate entry in the developer
    portal's public catalogue and carrying its own OpenAPI 3.1.0 document with the sandbox server and sandbox token endpoint.
    Operation surface is identical to the live API. Goodlord's getting-started guide states that a sandbox account is arranged
    by Goodlord's team during a commercial engagement and that production is enabled afterwards by an account manager, so
    this is a partner sandbox rather than an open trial — no self-serve key issuance exists.
  humanURL: https://portal.goodlord.co/portal/catalogue-products/referencing-product-1
  baseURL: https://api-sandbox.goodlord.co
  tags:
  - Referencing
  - Sandbox
  - Tenant Screening
  - Lettings
  properties:
  - type: OpenAPI
    url: openapi/goodlord-referencing-api-sandbox-openapi.json
  - type: Documentation
    url: https://portal.goodlord.co/portal/catalogue-products/referencing-product-1
  - type: APIReference
    url: https://portal.goodlord.co/portal/catalogue-products/referencing-product-1/dHlrL3Byb2Qtc2FuZGJveC1yZWZlcmVuY2luZy1hcGk/docs
  - type: Overlay
    url: overlays/goodlord-referencing-api-sandbox-overlay.yaml
  - type: Sandbox
    url: sandbox/goodlord-sandbox.yml
- aid: goodlord:goodlord-insurance-app-api
  name: Goodlord Insurance App API
  description: A second real Goodlord API surface, discovered outside the developer portal. The Goodlord Insurance App is
    an API Platform (Symfony) service whose OpenAPI 3.1.0 document is served publicly and unauthenticated at /api/v1/docs
    with the application/vnd.openapi+json media type. It covers rent protection insurance claims handling — insurance claims
    and claim submission, claim file upload and deletion, claim payments, rent schedules and rent schedule rows, plus agents,
    companies, roles and role groups. All 21 operations are gated by a JWT in the Authorization header and every collection
    probe returned HTTP 401. Goodlord does not list this API in its developer portal catalogue and publishes no onboarding
    path for it, so the contract is public but the API itself is an internal application surface, not an offered developer
    product.
  humanURL: https://insurance-app.goodlord.co/api/v1/docs
  baseURL: https://insurance-app.goodlord.co
  tags:
  - Insurance
  - Rent Protection
  - Claims
  - Payments
  - Rent Schedule
  properties:
  - type: OpenAPI
    url: openapi/goodlord-insurance-app-api-openapi.json
  - type: APIReference
    url: https://insurance-app.goodlord.co/api/v1/docs
  - type: Overlay
    url: overlays/goodlord-insurance-app-api-overlay.yaml
common:
- type: Conventions
  url: conventions/goodlord-conventions.yml
- type: ErrorCatalog
  url: errors/goodlord-problem-types.yml
- type: DataModel
  url: data-model/goodlord-data-model.yml
- type: Lifecycle
  url: lifecycle/goodlord-lifecycle.yml
- type: StatusPage
  url: https://goodlord.statuspal.io/
- type: Conformance
  url: conformance/goodlord-conformance.yml
- type: Compliance
  url: https://trust.goodlord.com/
- type: Sandbox
  url: sandbox/goodlord-sandbox.yml
- type: WellKnown
  url: well-known/goodlord-well-known.yml
- type: LLMsTxt
  url: llms/goodlord-llms.txt
- type: MCPServer
  url: mcp/goodlord-mcp.yml
- type: Webhooks
  url: asyncapi/goodlord-referencing-webhooks.yml
- type: AgentSkill
  url: skills/_index.yml
- type: APIReference
  url: https://portal.goodlord.co/portal/catalogue-products/referencing-product-1/dHlrL3Byb2QtcmVmZXJlbmNpbmctYXBp/docs
- type: GettingStarted
  url: https://portal.goodlord.co/blog/2024/8/22/getting-started-with-goodlords-referencing-api
- type: Support
  url: https://www.goodlord.com/support
- type: HelpCenter
  url: https://agenthelp.goodlord.co/s/
- type: TermsOfService
  url: https://www.goodlord.com/terms
- type: PrivacyPolicy
  url: https://www.goodlord.com/privacy-policy
- type: TrustCenter
  url: security/goodlord-trust-center.yml
- type: DomainSecurity
  url: security/goodlord-domain-security.yml
- type: AgenticAccess
  url: agentic-access/goodlord-agentic-access.yml
- type: OAuthScopes
  url: scopes/goodlord-scopes.yml
- type: Authentication
  url: authentication/goodlord-authentication.yml
- type: Website
  url: https://www.goodlord.com/
- type: DeveloperPortal
  url: https://portal.goodlord.co/
- type: Documentation
  url: https://portal.goodlord.co/portal/catalogue-products
- type: Blog
  url: https://www.goodlord.com/newsagent
- type: Blog
  url: https://portal.goodlord.co/blog
- type: Authentication
  url: https://portal.goodlord.co/portal/catalogue-products/referencing-product-1
- type: OpenIDConnectDiscovery
  url: https://login.goodlord.co/7ddbafdc-ee33-46fb-968a-3011e2a0a825/B2C_1A_2_SIGNUPORSIGNIN/v2.0/.well-known/openid-configuration
- type: Login
  url: https://app.goodlord.co/
- type: Partners
  url: https://www.goodlord.com/about/our-partners
- type: Integrations
  url: https://www.goodlord.com/platform/integrations
- type: Pricing
  url: https://www.goodlord.com/platform
- type: LinkedIn
  url: https://www.linkedin.com/company/goodlord
- type: Contact
  url: https://www.goodlord.com/contact-us
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com