Meta tags:
description=Aptly is a property management platform. This API gives external tools, scripts, and AI agents direct read/write access to your boards, cards, contacts, and more.;

Headings (most frequently used words):

this, is, introduction, documentation, index, on, page, how, aptly, structured, what, you, can, do, who, api, for, mcp, server, base, url, quick, start, getting, started, guides, reference,

Text of the page (most frequently used words):
api (21), the (21), and (19), aptly (17), board (15), this (9), for (9), cards (7), data (7), #documentation (6), create (6), card (6), field (6), schema (5), fetch (5), key (5), your (5), mcp (5), server (5), boards (5), read (5), all (5), https (4), getaptly (4), com (4), agents (4), contacts (4), use (4), before (4), index (4), introduction (4), reference (4), platform (3), core (3), boardid (3), list (3), keys (3), you (3), reading (3), writing (3), start (3), llms (3), scripts (3), workflows (3), that (3), update (3), property (3), management (3), tools (3), discover (3), external (3), can (3), company (3), structured (3), getting (3), started (3), authentication (2), name (2), value (2), content (2), type (2), token (2), your_api_key (2), curl (2), need (2), quick (2), base (2), url (2), model (2), agent (2), integrations (2), recommended (2), connect (2), push (2), look (2), building (2), pms (2), who (2), types (2), embed (2), add (2), any (2), records (2), across (2), from (2), what (2), record (2), resident (2), vendor (2), scoped (2), contact (2), uuid (2), work (2), identified (2), leasing (2), maintenance (2), how (2), more (2), gives (2), direct (2), write (2), access (2), complete (2), available (2), pages (2), exploring (2), further (2), txt (2), page (2), search (2), built, hosted, mintlify, developer, powered, john, smith, fieldkey, application, json, post, returns, under, section, click, give, copy, new, open, toggle, sources, enable, exposes, context, protocol, way, running, code, out, operators, automators, take, action, based, interface, agentic, between, other, like, platforms, telephony, systems, crms, developers, urls, tabs, directly, tab, views, attach, notes, documents, comments, files, people, email, manage, into, using, paginate, through, single, person, prospect, owner, linked, multiple, column, each, has, human, readable, label, text, date, money, multiselect, etc, get, full, individual, might, represent, lead, lease, order, _id, workspace, tracks, specific, workflow, examples, prospects, applications, orders, residents, active, leases, top, level, account, description, object, understanding, makes, much, easier, sync, build, custom, integration, automate, helps, companies, run, operations, here, endpoints, docs, changelog, delegate, tokens, app, actions, sdk, embedded, apps, dashboards, verification, lightweight, sso, guides, rate, limits, pagination, portal, navigation, home, skip, main, file,

Text of the page (random words):
introduction aptly api documentation index fetch the complete documentation index at llms txt use this file to discover all available pages before exploring further skip to main content aptly api home page aptly api search k search navigation getting started introduction documentation api reference aptly portal getting started introduction authentication mcp server pagination rate limits field types reference guides contact verification lightweight sso building embedded apps dashboards reference aptly sdk reference embed app actions delegate tokens changelog on this page how aptly is structured what you can do who this api is for mcp server base url quick start getting started introduction aptly is a property management platform this api gives external tools scripts and ai agents direct read write access to your boards cards contacts and more documentation index fetch the complete index of all available pages at https docs getaptly com llms txt start here to discover all endpoints before exploring further aptly is a property management platform that helps companies run leasing maintenance resident operations and more the aptly api gives external tools scripts and ai agents direct read write access to your aptly data use this api to sync data from a pms build a custom integration automate workflows or connect an ai agent to your boards how aptly is structured understanding the data model makes the api much easier to use object description company the top level account your api key is scoped to a company board a workspace that tracks a specific workflow examples a leasing board for prospects and applications a maintenance board for work orders a residents board for active leases identified by a boardid uuid card an individual record on a board a card might represent a lead a lease a work order or a vendor identified by _id field a structured data column on a board each field has a uuid key a human readable label and a type text date money multiselect etc fetch the board schema to get the full list before reading or writing contact a person record prospect resident owner vendor scoped to the company contacts can be linked to cards across multiple boards what you can do read and list cards paginate through all cards on a board or fetch a single card by id create and update cards push records into any board using field keys from the schema manage contacts create update and look up people records by email across all boards add comments and files attach notes or documents to any card add tab views embed external urls as tabs directly on a board read the board schema discover field keys and types before reading or writing data who this api is for developers building integrations between aptly and other tools like pms platforms telephony systems or crms ai agents that need to read board data create or update cards look up contacts or take action based on property management workflows the aptly mcp server is the recommended interface for agentic use operators and automators running scripts or no code workflows to push data in and out of aptly boards mcp server aptly exposes a model context protocol mcp server for ai agent integrations this is the recommended way to connect llms and ai agents to aptly base url https core api getaptly com quick start 1 enable the api for your board in aptly open the board card sources api and toggle the api on 2 create an api key under the api section click create new key give it a name and copy the key value 3 fetch the schema curl https core api getaptly com api schema boardid h x token your_api_key this returns the list of field keys you ll need for reading and writing cards 4 create a card curl x post https core api getaptly com api board boardid h x token your_api_key h content type application json d name john smith fieldkey value authentication i powered by this documentation is built and hosted on mintlify a developer documentation platform