Bring Aditum Connect® controls into the systems you already run.
The API is for system integrators and service operators who want tenant account controls, location visibility, and plan management to live inside the workflows they already use.
What Teams Usually Need
The practical integration layer
- Pull live client, location, and tenant records
- Expose supported account actions inside your own portal
- Connect plan changes to existing customer workflows
- Reduce support handoffs between tools
Where It Fits
The strongest integrations keep operators and tenants inside familiar systems. This page should help technical buyers understand what data is available, what the screens look like, and where the deeper live reference sits.
Reference Screens
Review each API operation in context.
List available clients
Start by retrieving the client records available to the authenticated partner or operator account.
List all available clients.
Retrieve location details
Pull location-level details and performance statistics when your system needs a deeper view of a specific property.
Retrieve location details and performance statistics.
List locations
Use the location list to identify the properties that can be queried, managed, or exposed inside an external workflow.
List all locations.
List available plans
Retrieve bandwidth plans before presenting tenant plan options or account-change controls.
List available bandwidth plans for a location.
List tenant accounts
Pull tenant account records for operational review, support workflows, or partner-facing account management screens.
List tenant accounts, including partner-filtered views.
Update tenant parameters
Use supported update actions when an external workflow needs to change tenant account settings.
Update supported tenant account parameters.
Look up a tenant by username
Retrieve a specific tenant account when a workflow starts from a username instead of a location-wide list.
Retrieve account details for a specified username.
Review tenant status by location
Retrieve current tenant status and account details when the workflow needs a building-level view.
Retrieve current status and details for all tenants at a location.
Typical Workflows
Most integrations follow a small number of patterns.
You do not need a sprawling integration to get value. The strongest implementations usually start with a tight operational use case and expand from there.
Pull the records you need
List clients, locations, tenant accounts, or available bandwidth plans so your own system starts from live Aditum Connect® data.
Expose the right controls
Present plan-change or account-management actions inside your existing portal, CRM, or support workflow instead of sending users somewhere else.
Keep operations aligned
Use the same integration to support tenant experience, service operations, and account workflows across the property.
Common Operations
What teams usually call first
- List all available clients
- Retrieve location details and performance statistics
- List available bandwidth plans for a location
- List tenant accounts, optionally filtered by client
- Retrieve account details for a specified username
- Update supported parameters for a tenant account
- Retrieve current tenant status for a location
Live Reference
Keep the detailed documentation nearby
The expandable reference cards help teams scan the API quickly. The embedded reference keeps the full endpoint material available on the same page instead of sending them into a disconnected experience.
Note: the embedded reference is still here for deeper endpoint review after the summary cards.