# Aptly API

## Docs

- [Add a tab view](https://docs.getaptly.com/api-reference/board/add-a-tab-view.md): Adds an embedded tab view to the board's tab list.
- [Add or update a comment](https://docs.getaptly.com/api-reference/cards/add-or-update-a-comment.md): Adds a new comment to a card. To update an existing comment, include its `id` in the body — the `userId` must match the original comment's author.
- [Create a card](https://docs.getaptly.com/api-reference/cards/create-a-card.md): Creates a new card on the board. Use field UUIDs (from the schema endpoint) as keys in the request body.
- [Get a card](https://docs.getaptly.com/api-reference/cards/get-a-card.md): Returns a single card by its ID.
- [Get comments on a card](https://docs.getaptly.com/api-reference/cards/get-comments-on-a-card.md): Returns all comments on the specified card.
- [Get contacts linked to a card](https://docs.getaptly.com/api-reference/cards/get-contacts-linked-to-a-card.md): Returns all contacts linked to a card via its `person` or `persons` fields.
- [List cards](https://docs.getaptly.com/api-reference/cards/list-cards.md): Returns a paginated list of cards on the board.
- [Update a card](https://docs.getaptly.com/api-reference/cards/update-a-card.md): Updates an existing card. Provide `_id` in the request body to identify the card. Returns 404 if no card with that ID exists on the board.
- [Upload a file to a card](https://docs.getaptly.com/api-reference/cards/upload-a-file-to-a-card.md): Uploads a file and attaches it to a card. Send as `multipart/form-data` with the file in the `file` field.
- [Confirm contact email verification](https://docs.getaptly.com/api-reference/contacts/confirm-contact-email-verification.md): Submits the 6-digit code received by email. Returns the matching contact records if the code is valid, not expired, and has not already been used.
- [Create or update a contact](https://docs.getaptly.com/api-reference/contacts/create-or-update-a-contact.md): Creates a new contact or updates an existing one.
- [Get a contact](https://docs.getaptly.com/api-reference/contacts/get-a-contact.md): Returns a single contact by ID.
- [Initiate contact email verification](https://docs.getaptly.com/api-reference/contacts/initiate-contact-email-verification.md): Looks up an email address against your org's contact database. If a match is found, generates a cryptographically strong 6-digit code, sends it to the address, and returns a `requestId` and `verifyUrl` to complete the verification.
- [List contacts](https://docs.getaptly.com/api-reference/contacts/list-contacts.md): Returns a paginated list of contacts for your company.
- [Look up contacts by email](https://docs.getaptly.com/api-reference/contacts/look-up-contacts-by-email.md): Returns contacts whose email address matches one or more of the provided values. Matching is case-insensitive and exact. Results are scoped to your company.
- [Update a contact](https://docs.getaptly.com/api-reference/contacts/update-a-contact.md): Updates an existing contact by ID. Fields not provided are left unchanged.
- [Get nearby schools for a property](https://docs.getaptly.com/api-reference/context-&-locations/get-nearby-schools-for-a-property.md)
- [Get single listing details](https://docs.getaptly.com/api-reference/context-&-locations/get-single-listing-details.md)
- [List all locations for an organization](https://docs.getaptly.com/api-reference/context-&-locations/list-all-locations-for-an-organization.md)
- [List public property listings](https://docs.getaptly.com/api-reference/context-&-locations/list-public-property-listings.md)
- [Load company-level config](https://docs.getaptly.com/api-reference/context-&-locations/load-company-level-config.md)
- [Load property/location context](https://docs.getaptly.com/api-reference/context-&-locations/load-propertylocation-context.md)
- [Get embeddable form definition](https://docs.getaptly.com/api-reference/forms/get-embeddable-form-definition.md)
- [Search locations for form location picker](https://docs.getaptly.com/api-reference/forms/search-locations-for-form-location-picker.md)
- [Submit a completed form](https://docs.getaptly.com/api-reference/forms/submit-a-completed-form.md)
- [Get knowledge base document](https://docs.getaptly.com/api-reference/knowledge-base/get-knowledge-base-document.md)
- [Create a knowledge document](https://docs.getaptly.com/api-reference/knowledge/create-a-knowledge-document.md): Creates a new knowledge document scoped to your company. Optionally associates the document with a board (`aptletUuid`), a card (`aptletInstanceId`), or a parent document (`parentId`).
- [Get a knowledge document](https://docs.getaptly.com/api-reference/knowledge/get-a-knowledge-document.md): Returns a knowledge document's content rendered as HTML.
- [Update a knowledge document](https://docs.getaptly.com/api-reference/knowledge/update-a-knowledge-document.md): Updates a knowledge document's content and/or metadata. Only fields provided in the request body are updated — omitted fields are left unchanged.
- [Get board schema](https://docs.getaptly.com/api-reference/schema/get-board-schema.md): Returns the list of fields defined on the board. Always fetch the schema first so you know which field keys to use when reading or writing card data.
- [List users](https://docs.getaptly.com/api-reference/users/list-users.md): Returns all active users for the company associated with the API key.
- [Authentication](https://docs.getaptly.com/authentication.md): How to authenticate requests to the Aptly API.
- [Contact Verification & Lightweight SSO](https://docs.getaptly.com/contact-verification-sso.md): Use the email verification flow to confirm a contact's identity, then load their data — no passwords required.
- [Introduction](https://docs.getaptly.com/introduction.md): Read and write cards on any Aptly board from external systems.
- [Context & Locations](https://docs.getaptly.com/portal/api-context.md): Company/org config, property listings, location search, and nearby schools.
- [Forms](https://docs.getaptly.com/portal/api-forms.md): Embeddable external forms with location search for third-party websites.
- [Knowledge Base](https://docs.getaptly.com/portal/api-knowledge.md): Retrieve help and knowledge documents for display in the portal.
- [Aptly Portal API](https://docs.getaptly.com/portal/introduction.md): HTTP API for the Aptly rental application screening portal.

## OpenAPI Specs

- [openapi](https://docs.getaptly.com/openapi.yaml)