Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RentCheck Communities API

The Communities API from RentCheck — 3 operation(s) for communities.

RentCheck Communities API is one of 31 APIs that RentCheck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Communities. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://prod-public-api.getrentcheck.com.

5 operations 3 paths 7 schemas 1 DELETE1 GET1 POST2 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://prod-public-api.getrentcheck.com
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

RentCheck Communities API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as x-app-id (x-app-id). An API key is passed in the header as x-app-secret (x-app-secret). By default, every request must be authenticated.

  • bearerAuth — Authorization key needed to use the API
  • x-app-id — Represents the identification of you application
  • x-app-secret — Represents the secret for your application

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Communities 5
POST
/v1/communities
Create a community
body → 200400401404
DELETE
/v1/communities
Delete communities
1 param → 200401403
GET
/v1/communities/{communityId}
Get a community by id
1 param → 200401404
PUT
/v1/communities/{communityId}
Update a community
1 param body → 200400401404
PUT
/v1/properties/{propertyId}/merge/{targetPropertyId}
Merge two properties
2 params body → 200401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are unit_response_model (24 properties), building_response_model (23 properties), community_response_model (22 properties), community_create_request_model (11 properties). Each schema is shown below with its type and property counts.

properties_merge_request_model
object
1 property
community_update_request_model
object
11 properties
community_response_model
object
22 properties 18 required
unit_response_model
object
24 properties 20 required
community_create_request_model
object
11 properties 5 required
room_info
object
Structured room entry.
3 properties 3 required
building_response_model
object
23 properties 19 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rentcheck-communities-api-openapi.yml Raw ↑

Other APIs RentCheck publishes across the network.

RentCheck Account Settings API
RentCheck Automations API
RentCheck Buildings API
RentCheck Chargebee API
RentCheck Dashboard API
RentCheck File Requests API
RentCheck Filter Segments API
RentCheck Inspection Features API
RentCheck Inspections API
RentCheck Inspections Templates API
RentCheck Inspections V2 API
RentCheck Integrations API