# Aptly API

## Docs

- [Create or update a card](https://aptly-1c228e04.mintlify.app/api-reference/boards/create-or-update-a-card.md): Posts a new card to the board. The format of this post is a JSON object containing key/value pairs where the key is the **name** of the field (not the UUID), and the value is the value you wish to post.
- [Get board schema](https://aptly-1c228e04.mintlify.app/api-reference/boards/get-board-schema.md): Returns the field schema for the board, including all field names and their UUIDs.
- [Get cards for a board](https://aptly-1c228e04.mintlify.app/api-reference/boards/get-cards-for-a-board.md): Returns cards on a board specified by board ID. The URL with the board ID is available in the Aptly UI under **Card Sources > API**.
- [Get a card](https://aptly-1c228e04.mintlify.app/api-reference/cards/get-a-card.md): Returns the specific card based on the ID.
- [Post a comment to a card](https://aptly-1c228e04.mintlify.app/api-reference/cards/post-a-comment-to-a-card.md): Post a comment onto a card instance.
- [Post a file to a card](https://aptly-1c228e04.mintlify.app/api-reference/cards/post-a-file-to-a-card.md): Post a file to a card instance. The file should be base64 encoded.
- [Create or update a contact](https://aptly-1c228e04.mintlify.app/api-reference/contacts-&-users/create-or-update-a-contact.md): Creates a new contact or updates an existing one if `_id` is provided.
- [Get contact](https://aptly-1c228e04.mintlify.app/api-reference/contacts-&-users/get-contact.md): Returns a list of contacts.
- [Get users](https://aptly-1c228e04.mintlify.app/api-reference/contacts-&-users/get-users.md): Returns a list of users in your Aptly organization.
- [Authentication](https://aptly-1c228e04.mintlify.app/authentication.md): How to authenticate with the Aptly API
- [changelog](https://aptly-1c228e04.mintlify.app/changelog.md): A record of changes to the Aptly API
- [Core Concepts](https://aptly-1c228e04.mintlify.app/core-concepts.md): The key building blocks of Aptly and how they relate to each other
- [Errors](https://aptly-1c228e04.mintlify.app/errors.md): HTTP status codes, common error responses, and how to fix them
- [Gotchas & Quirks](https://aptly-1c228e04.mintlify.app/gotchas.md): Common mistakes and non-obvious behaviors to be aware of when integrating with the Aptly API
- [MCP Server](https://aptly-1c228e04.mintlify.app/mcp-server.md): Connect Aptly to AI assistants like Claude using the Model Context Protocol
- [Pagination](https://aptly-1c228e04.mintlify.app/pagination.md): How to retrieve large sets of cards from the Aptly API
- [Quickstart](https://aptly-1c228e04.mintlify.app/quickstart.md): Make your first Aptly API call in under five minutes
- [Create a card](https://aptly-1c228e04.mintlify.app/recipes/create-card.md): Post a new card to a board with field values
- [Build a custom report](https://aptly-1c228e04.mintlify.app/recipes/custom-report.md): Pull all cards from a board and generate a summary report grouped by stage
- [Filter results](https://aptly-1c228e04.mintlify.app/recipes/filter-results.md): Retrieve only the cards that match specific field values
- [Making your first request](https://aptly-1c228e04.mintlify.app/recipes/first-request.md): Get authenticated and make your first successful API call
- [Get data from a board](https://aptly-1c228e04.mintlify.app/recipes/get-board-data.md): Paginate through all cards on a board and collect the full data set
- [Recipes](https://aptly-1c228e04.mintlify.app/recipes/index.md): Step-by-step guides for common Aptly API integrations
- [Update a card](https://aptly-1c228e04.mintlify.app/recipes/update-card.md): Update an existing card on a board using its ID
- [React to a card update](https://aptly-1c228e04.mintlify.app/recipes/webhook-handler.md): Receive a webhook, verify the signing key, and process the payload
- [Webhooks](https://aptly-1c228e04.mintlify.app/webhooks.md): Receive real-time notifications when activity occurs on an Aptly board

## OpenAPI Specs

- [aptly-openapi](https://aptly-1c228e04.mintlify.app/aptly-openapi.yaml)
- [openapi](https://aptly-1c228e04.mintlify.app/api-reference/openapi.json)