Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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

MethodContent-TypeBody
GETapplication/jsonnone
POST (JSON)application/jsonJSON
POST (file upload)(omitted, multipart auto-set)FormData
DELETEapplication/jsonnone
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" }
ReasonStatusDescription
"jwt expired"401Token has expired — re-authenticate via the verification flow
"Unauthorized"401Token is missing or invalid
"Not found"404The requested resource does not exist
"Invalid orgId"400The organization ID is missing or does not match any known org
"Form not found"404The form ID does not exist or is not active for this org
"Location not found"404The property or location ID does not exist within this org
"Verification code invalid or expired"400The 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:
NameWhere it appears
orgIdQuery parameters on most Portal API endpoints
companyIdReturned in company config responses
contextIdUsed 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

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