Aptly Portal API

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" }

Error responses

All errors return a JSON body with a reason field:

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

Reason	Status	Description
`"jwt expired"`	401	Token has expired — re-authenticate via the verification flow
`"Unauthorized"`	401	Token is missing or invalid
`"Not found"`	404	The requested resource does not exist
`"Invalid orgId"`	400	The organization ID is missing or does not match any known org
`"Form not found"`	404	The form ID does not exist or is not active for this org
`"Location not found"`	404	The property or location ID does not exist within this org
`"Verification code invalid or expired"`	400	The submitted code was incorrect, already used, or has expired

Multi-tenancy

Every organization has a unique identifier that scopes all API calls. This ID appears in different fields depending on the endpoint:

Name	Where it appears
`orgId`	Query parameters on most Portal API endpoints
`companyId`	Returned in company config responses
`contextId`	Used internally in some form and knowledge endpoints

These all refer to the same organization. When an endpoint asks for orgId, use your organization’s ID regardless of what it is called elsewhere. If you are unsure of your orgId, call the Load company-level config endpoint — it is returned in the response.

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

Overview

Public API

API Reference

Environments

Request & Response Format

Error responses

Multi-tenancy

Common Data Types

Public API

Context & Locations

Knowledge Base

Forms

​Environments

​Request & Response Format

​Error responses

​Multi-tenancy

​Common Data Types

​Public API

Context & Locations

Knowledge Base

Forms

Environments

Request & Response Format

Error responses

Multi-tenancy

Common Data Types

Public API