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 Automations API

The Automations API from RentCheck — 2 operation(s) for automations.

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

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

This API exposes 5 operations across 2 paths, and defines 4 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 2 paths 4 schemas 1 DELETE2 GET1 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://prod-public-api.getrentcheck.com
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

RentCheck Automations 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Automations 5
POST
/v1/automations
Create an automation
body → 201400401404409
GET
/v1/automations
List automations for the caller's subscription
4 params → 200400401404
DELETE
/v1/automations/{automationId}
Delete an automation
1 param → 204400401404
GET
/v1/automations/{automationId}
Get an automation by ID
1 param → 200400401404
PUT
/v1/automations/{automationId}
Update an automation
1 param body → 200400401404409

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are api_automation (15 properties), automation_update_request_model (9 properties), automation_create_request_model (8 properties). Each schema is shown below with its type and property counts.

api_automation
object
Inspection automation record.
15 properties 14 required
automation_create_request_model
object
Request body for creating an automation.
8 properties 6 required
automation_get_all_response_model
array
Paginated list of automations.
automation_update_request_model
object
All fields are optional, but if recurrence is supplied then triggertype must also be supplied.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rentcheck-automations-api-openapi.yml Raw ↑

Other APIs RentCheck publishes across the network.

RentCheck Account Settings API
RentCheck Buildings API
RentCheck Chargebee API
RentCheck Communities 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