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 Insurance App API

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.

Goodlord Insurance App API is one of 3 APIs that Goodlord publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Insurance, Rent Protection, Claims, Payments, and Rent Schedule. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 35 operations across 21 paths, organized into 11 resource areas, and defines 96 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against 4 base URLs: https://insurance-app.goodlord.co/, https://insurance-app.staging.goodoverlord.com/, https://insurance-app.qa1.goodoverlord.com/, https://insurance-app.demo.goodlord.co/.

35 operations 21 paths 96 schemas 4 DELETE17 GET5 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://insurance-app.goodlord.co
Authentication
API Key
Resource Areas
11

Authentication & Security 1

Goodlord Insurance App API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (JWT). By default, every request must be authenticated.

  • JWT — Value for the Authorization header parameter.

Paths & Operations 35

Across 21 paths, the API surfaces 35 operations — 4 DELETE, 17 GET, 5 PATCH, 9 POST. They span 11 resource areas, including Agent, Company, File, InsuranceClaim, Payment, RentSchedule, RentScheduleRow, RentScheduleRowUpdate, and 3 more. Each is listed below with its method, path, parameters, and response codes.

Agent 5

Resource 'Agent' operations.

GET
/api/v1/agents
Retrieves the collection of Agent resources.
api_agents_get_collection 2 params → 200403
POST
/api/v1/agents
Creates a Agent resource.
api_agents_post body → 201400422403
GET
/api/v1/agents/{id}
Retrieves a Agent resource.
api_agents_id_get 1 param → 200403404
PATCH
/api/v1/agents/{id}
Updates the Agent resource.
api_agents_id_patch 1 param body → 200400422403404
GET
/api/v1/me
Retrieves a Agent resource.
get_me 1 param → 200403404
Company 2

Resource 'Company' operations.

GET
/api/v1/companies
Retrieves the collection of Company resources.
api_companies_get_collection 2 params → 200403
GET
/api/v1/companies/{id}
Retrieves a Company resource.
api_companies_id_get 1 param → 200403404
File 4

Resource 'File' operations.

GET
/api/v1/insurance_claims/{insuranceClaimId}/files
Retrieves the collection of File resources.
api_insurance_claims_insuranceClaimIdfiles_get_collection 3 params → 200403
POST
/api/v1/insurance_claims/{insuranceClaimId}/files
Upload a file to an insurance claim
api_insurance_claims_insuranceClaimIdfiles_post 1 param body → 201400422403
GET
/api/v1/insurance_claims/{insuranceClaimId}/files/{id}
Retrieves a File resource.
api_insurance_claims_insuranceClaimIdfiles_id_get 2 params → 200403404
DELETE
/api/v1/insurance_claims/{insuranceClaimId}/files/{id}
Removes the File resource.
api_insurance_claims_insuranceClaimIdfiles_id_delete 2 params → 204403404
InsuranceClaim 5

Resource 'InsuranceClaim' operations.

GET
/api/v1/insurance_claims
Retrieves the collection of InsuranceClaim resources.
api_insurance_claims_get_collection 13 params → 200403
POST
/api/v1/insurance_claims
Creates a InsuranceClaimCreate resource.
api_insurance_claims_post body → 201400422
GET
/api/v1/insurance_claims/{id}
Retrieves a InsuranceClaim resource.
api_insurance_claims_id_get 2 params → 200403404
PATCH
/api/v1/insurance_claims/{id}
Update insurance claim details
api_insurance_claims_id_patch 1 param body → 200400422404
POST
/api/v1/insurance_claims/{id}/submit
Submit an insurance claim
api_insurance_claims_idsubmit_post 1 param body → 201400422403
Payment 2

Resource 'Payment' operations.

GET
/api/v1/insurance_claims/{insuranceClaimId}/payments
Retrieves the collection of Payment resources.
api_insurance_claims_insuranceClaimIdpayments_get_collection 3 params → 200403
GET
/api/v1/insurance_claims/{insuranceClaimId}/payments/{id}
Retrieves a Payment resource.
api_insurance_claims_insuranceClaimIdpayments_id_get 2 params → 200403404
RentSchedule 3

Resource 'RentSchedule' operations.

GET
/api/v1/insurance_claims/{insuranceClaimId}/rent_schedule
Retrieves a RentSchedule resource.
api_insurance_claims_insuranceClaimIdrent_schedule_get 2 params → 200403404
POST
/api/v1/insurance_claims/{insuranceClaimId}/rent_schedule/{rentScheduleId}/rent_schedule_rows
Create multiple rent schedule rows
api_insurance_claims_insuranceClaimIdrent_schedule_rentScheduleIdrent_schedule_rows_post 2 params body → 204400422
POST
/api/v1/insurance_claims/{insuranceClaimId}/rent_schedule/{rentScheduleId}/submit
Creates a RentSchedule resource.
api_insurance_claims_insuranceClaimIdrent_schedule_rentScheduleIdsubmit_post 2 params body → 201400422403
RentScheduleRow 2

Resource 'RentScheduleRow' operations.

GET
/api/v1/insurance_claims/{insuranceClaimId}/rent_schedule/{rentScheduleId}/rent_schedule_row/{id}
Retrieves a RentScheduleRow resource.
api_insurance_claims_insuranceClaimIdrent_schedule_rentScheduleIdrent_schedule_row_id_get 4 params → 200403404
DELETE
/api/v1/insurance_claims/{insuranceClaimId}/rent_schedule/{rentScheduleId}/rent_schedule_row/{id}
Removes the RentScheduleRow resource.
api_insurance_claims_insuranceClaimIdrent_schedule_rentScheduleIdrent_schedule_row_id_delete 3 params → 204403404
RentScheduleRowUpdate 1

Resource 'RentScheduleRowUpdate' operations.

PATCH
/api/v1/insurance_claims/{insuranceClaimId}/rent_schedule/{rentScheduleId}/rent_schedule_row/{id}
Updates the RentScheduleRowUpdate resource.
api_insurance_claims_insuranceClaimIdrent_schedule_rentScheduleIdrent_schedule_row_id_patch 3 params body → 200400422403404
RentScheduleRowPostDto 1

Resource 'RentScheduleRowPostDto' operations.

POST
/api/v1/insurance_claims/{insuranceClaimId}/rent_schedule/{rentScheduleId}/rent_schedule_row
Creates a RentScheduleRowPostDto resource.
api_insurance_claims_insuranceClaimIdrent_schedule_rentScheduleIdrent_schedule_row_post 2 params body → 201400422
Role 5

Resource 'Role' operations.

GET
/api/v1/roles
Retrieves the collection of Role resources.
api_roles_get_collection 2 params → 200403
POST
/api/v1/roles
Creates a Role resource.
api_roles_post body → 201400422403
GET
/api/v1/roles/{id}
Retrieves a Role resource.
api_roles_id_get 1 param → 200403404
DELETE
/api/v1/roles/{id}
Removes the Role resource.
api_roles_id_delete 1 param → 204403404
PATCH
/api/v1/roles/{id}
Updates the Role resource.
api_roles_id_patch 1 param body → 200400422403404
RoleGroup 5

Resource 'RoleGroup' operations.

GET
/api/v1/role_groups
Retrieves the collection of RoleGroup resources.
api_role_groups_get_collection 2 params → 200403
POST
/api/v1/role_groups
Creates a RoleGroup resource.
api_role_groups_post body → 201400422403
GET
/api/v1/role_groups/{id}
Retrieves a RoleGroup resource.
api_role_groups_id_get 1 param → 200403404
DELETE
/api/v1/role_groups/{id}
Removes the RoleGroup resource.
api_role_groups_id_delete 1 param → 204403404
PATCH
/api/v1/role_groups/{id}
Updates the RoleGroup resource.
api_role_groups_id_patch 1 param body → 200400422403404

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are InsuranceClaim-insurance_claim.read (119 properties), InsuranceClaim.csv (119 properties), InsuranceClaim.csv-insurance_claim.read (119 properties), InsuranceClaimCreate.InsuranceClaimGetDto-insurance_claim.read (119 properties). Each schema is shown below with its type and property counts.

Agent
object
5 properties
Agent-agent_user.read
object
4 properties
Agent-me.get
object
5 properties
Agent.AppUserGetDto.jsonapi-me.get
object
2 properties
Agent.UserWithClaimData-me.get
object
4 properties
Agent.UserWithClaimData.csv-me.get
object
4 properties
Agent.csv
object
5 properties
Agent.csv-agent_user.read
object
4 properties
Agent.csv-me.get
object
5 properties
Agent.jsonMergePatch
object
5 properties
Agent.jsonapi
object
2 properties
Company
object
3 properties
Company-agent_user.read
object
2 properties
Company-insurance_claim.read
object
3 properties
Company-me.get
object
2 properties
Company.csv
object
3 properties
Company.csv-agent_user.read
object
2 properties
Company.csv-insurance_claim.read
object
3 properties
Company.csv-me.get
object
2 properties
Company.jsonapi
object
1 property
ConstraintViolation
object
Unprocessable entity
5 properties
ConstraintViolation.jsonapi
object
1 property
Currency
object
1 property
Currency.csv
object
1 property
Error
object
A representation of common errors.
8 properties
Error.jsonapi
object
1 property
File
object
9 properties
File-file.read
object
9 properties
File-insurance_claim.read
object
7 properties
File.csv
object
9 properties
File.csv-file.read
object
9 properties
File.csv-insurance_claim.read
object
7 properties
File.jsonapi
object
2 properties
FileCreate.FileGetModel
object
Input DTO for file upload operations. Separate from FileGetModel to allow different OpenAPI schemas for input vs output.
9 properties
FileCreate.FilePostDto.jsonapi
object
1 property
InsuranceClaim
object
119 properties
InsuranceClaim-insurance_claim.read
object
119 properties
InsuranceClaim-rent_schedule.read
object
32 properties
InsuranceClaim-rent_schedule_row.read
object
31 properties
InsuranceClaim.csv
object
119 properties
InsuranceClaim.csv-insurance_claim.read
object
119 properties
InsuranceClaim.csv-rent_schedule.read
object
32 properties
InsuranceClaim.csv-rent_schedule_row.read
object
31 properties
InsuranceClaim.jsonapi
object
2 properties
InsuranceClaimCreate.InsuranceClaimGetDto-insurance_claim.read
object
119 properties
InsuranceClaimCreate.InsuranceClaimGetDto.csv-insurance_claim.read
object
119 properties
InsuranceClaimCreate.InsuranceClaimPostDto.jsonapi-insurance_claim.read
object
1 property
InsuranceClaimUpdate.InsuranceClaimGetDto-insurance_claim.read
object
119 properties
InsuranceClaimUpdate.InsuranceClaimGetDto.csv-insurance_claim.read
object
119 properties
InsuranceClaimUpdate.InsuranceClaimPatchDto.jsonapi-insurance_claim.read
object
1 property
JsonApiCollectionBaseSchema
JsonApiCollectionBaseSchemaNoPagination
object
3 properties 1 required
Money
object
7 properties
Money.csv
object
7 properties
Payment
object
14 properties
Payment-insurance_claim.read
object
13 properties
Payment-payment.read
object
14 properties
Payment.csv-insurance_claim.read
object
13 properties
Payment.csv-payment.read
object
14 properties
Payment.jsonapi
object
2 properties
RentSchedule
object
8 properties
RentSchedule-rent_schedule.read
object
8 properties
RentSchedule-rent_schedule_row.read
object
6 properties
RentSchedule.csv
object
8 properties
RentSchedule.csv-rent_schedule.read
object
8 properties
RentSchedule.csv-rent_schedule_row.read
object
6 properties
RentSchedule.jsonapi
object
2 properties
RentScheduleRow
object
15 properties
RentScheduleRow-rent_schedule.read
object
12 properties
RentScheduleRow-rent_schedule_row.read
object
13 properties
RentScheduleRow.csv-rent_schedule.read
object
12 properties
RentScheduleRow.csv-rent_schedule_row.read
object
13 properties
RentScheduleRow.jsonapi
object
2 properties
RentScheduleRowAuditGetDto
object
5 properties
RentScheduleRowAuditGetDto-rent_schedule_row.read
object
5 properties
RentScheduleRowAuditGetDto.csv
object
5 properties
RentScheduleRowAuditGetDto.csv-rent_schedule_row.read
object
5 properties
RentScheduleRowPostDto
object
4 properties 2 required
RentScheduleRowPostDto.RentScheduleRowGetModel
object
15 properties
RentScheduleRowPostDto.RentScheduleRowGetModel.csv
object
15 properties
RentScheduleRowPostDto.RentScheduleRowPostDto.jsonapi
object
1 property
RentScheduleRowPostDto.csv
object
4 properties 2 required
RentScheduleRowPostDto.jsonapi
object
1 property
RentScheduleRowUpdate.RentScheduleRowGetModel
object
15 properties
RentScheduleRowUpdate.RentScheduleRowGetModel.csv
object
15 properties
RentScheduleRowUpdate.RentScheduleRowPatchDto.jsonapi
object
1 property
RentScheduleRowUpdate.jsonMergePatch
object
3 properties
RentScheduleRowUpdate.jsonapi
object
1 property
Role
object
6 properties 1 required
Role.csv
object
6 properties 1 required
Role.jsonMergePatch
object
6 properties
Role.jsonapi
object
2 properties
RoleGroup
object
8 properties
RoleGroup.csv
object
8 properties
RoleGroup.jsonMergePatch
object
8 properties
RoleGroup.jsonapi
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

goodlord-insurance-app-api-openapi.json Raw ↑

Other APIs Goodlord publishes across the network.

Goodlord Referencing API
Goodlord Referencing API (Sandbox)
Where this information came from

This is an independent, third-party profile of Goodlord Insurance App 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.