How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Goodlord Referencing API (Sandbox)

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.

Goodlord Referencing API (Sandbox) is one of 3 APIs that Goodlord publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Referencing, Sandbox, Tenant Screening, and Lettings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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-sandbox.goodlord.co.

15 operations 10 paths 12 schemas 2 DELETE6 GET3 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api-sandbox.goodlord.co
Authentication
OAuth 2.0
Contact
License
Terms of Service
Resource Areas
4

Authentication & Security 1

Goodlord Referencing API (Sandbox) 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 1

Authentication operations

POST
/auth/token
Obtain a JWT token
getAuthToken body → 200
Application 4

An application contains rental information and all of the applicants/guarantors which are applying for a tenancy.

POST
/referencing/application
Create a new application
createApplication 1 param body → 200400500
GET
/referencing/application/{applicationId}
Get Application
getApplication 2 params → 200400404500
PATCH
/referencing/application/{applicationId}
Patch Application
patchApplication 2 params body → 200400404500
DELETE
/referencing/application/{applicationId}
Delete Application
deleteApplication 2 params → 200400404500
Subject 9

A person who exists on an application.

GET
/referencing/subject/{subjectId}/auth/tokendeprecated
Get Bot JWT Token
getBotToken 1 param → 200400404500
POST
/referencing/subject/{subjectId}/auth/token
Create Bot JWT Token
createBotToken 1 param body → 200400404500
GET
/referencing/subject/{subjectId}
Get Subject
getSubject 2 params → 200400404500
PATCH
/referencing/subject/{subjectId}
Patch Subject
patchSubject 2 params body → 200400404500
DELETE
/referencing/subject/{subjectId}
Delete Subject
deleteSubject 2 params → 200400404500
PUT
/referencing/subject/application/{applicationId}
Create Subject
createSubject 2 params body → 200400404500
GET
/referencing/subject/{subjectId}/touchpoints
Get Subject Touchpoints
getSubjectTouchpoints 1 param → 200400404500
PATCH
/referencing/subject/{subjectId}/outcome/conditions
Patch Subject Outcome Conditions
patchSubjectOutcomeConditions 1 param body → 200400404500
GET
/referencing/subject/{subjectId}/emails
Get Subject Emails
getSubjectEmails 1 param → 200400404500
Media 1

Operations which are concerned around retrieving files

GET
/referencing/media/document/{documentId}
Get Authenticated File Url
getAuthenticatedFile 1 param → 200400404500

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.

CreateSubjectRequest
object
5 properties 4 required
PatchSubjectRequest
object
Supply only the properties you wish to change. The context block is required and must include at least one property; rentalDetails is optional.
2 properties 1 required
PatchApplicationRequest
object
1 property 1 required
CreateApplicationRequest
object
2 properties 2 required
Application
object
An application contains rental information and all of the applicants/guarantors which are applying for a tenancy.
5 properties
PatchSubjectOutcomeConditionsRequest
object
Patch a subject's outcome conditions
2 properties 2 required
Subject
object
A subject is a person who is part of an application.
9 properties
ApiMessageResponse
object
1 property
APITouchpoint
object
A touchpoint represents a communication or interaction point for a subject.
6 properties 6 required
APITouchpointAuthor
object
The author of a touchpoint.
3 properties 1 required
APIErrorResponse
object
1 property 1 required
APIEmail
object
The information about an email sent to an applicant
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

goodlord-referencing-api-sandbox-openapi.json Raw ↑

Other APIs Goodlord publishes across the network.

Goodlord Referencing API
Goodlord Insurance App API
Where this information came from

This is an independent, third-party profile of Goodlord Referencing API (Sandbox), 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.