Aptly Portal API

HTTP API for the Aptly rental application screening portal.

Environments

The base URL for all API calls is:

https://app.getaptly.com/api/portal

All endpoint paths are relative to it.

Request & Response Format

Method	Content-Type	Body
GET	application/json	none
POST (JSON)	application/json	JSON
POST (file upload)	(omitted, multipart auto-set)	FormData
DELETE	application/json	none

All responses are JSON. On success the HTTP status is 2xx. On failure:

{ "reason": "human-readable error string" }

Reason	Description
"jwt expired"	Token expired — re-authenticate
"Unauthorized"	Missing or invalid token
"Not found"	Resource does not exist

Multi-tenancy

Every organization has an orgId (also called companyId or contextId). All API calls must be scoped to this ID.

Common Data Types

Address

{
  "formattedAddress": "123 Main St, Austin TX 78701",
  "state": "TX",
  "countryName": "United States"
}

Public API

Context & Locations

Company/org config, property listings, location search, nearby schools

Knowledge Base

Retrieve help/knowledge documents

Forms

Embeddable external forms with location search