> For the complete documentation index, see [llms.txt](https://docs.ventrata.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ventrata.com/getting-started/request-capabilities.md).

# Endpoints & Capabilities

Ventrata supports all OCTO Core endpoints plus optional capability extensions.

This page documents the reseller-facing `octo/*` capability set from the API source (`dashboard/app/controllers/apis/octo_controller.rb` and `dashboard/app/controllers/apis/octo/*_capability.rb`).

## OCTO Core Endpoints

Core endpoint routes are documented in these pages:

* [Products](/octo-core/products.md)
* [Availability](/octo-core/availability.md)
* [Bookings](/octo-core/bookings.md)

{% openapi src="/files/9aBZzqykFPaTU7bfbNrr" path="/capabilities" method="get" %}
[openapi.yaml](https://221588849-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M7bgGIyO7QYNOfUMfxh%2Fuploads%2Fgit-blob-fa2d8cb1d7297d352c2639e6c4c6a990f2add6d7%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/9aBZzqykFPaTU7bfbNrr" path="/whoami" method="get" %}
[openapi.yaml](https://221588849-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M7bgGIyO7QYNOfUMfxh%2Fuploads%2Fgit-blob-fa2d8cb1d7297d352c2639e6c4c6a990f2add6d7%2Fopenapi.yaml?alt=media)
{% endopenapi %}

## `octo/*` Capability Coverage

| Capability ID        | Internal | Documentation                                       | API Surface                                                                                      |
| -------------------- | -------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `octo/pricing`       | No       | [Pricing](/capabilities/pricing.md)                 | Pricing fields across products/availability/bookings/orders/gifts.                               |
| `octo/content`       | No       | [Content](/capabilities/content.md)                 | Extends product/option/unit/availability/booking content fields.                                 |
| `octo/offers`        | No       | [Promotions / Offers](/capabilities/offers.md)      | Supplier offers and offer-aware pricing/booking responses.                                       |
| `octo/extras`        | No       | [Extras](/capabilities/extras.md)                   | Extra upsell inventory and booking extra-items behavior.                                         |
| `octo/packages`      | No       | [Packages](/capabilities/packages.md)               | Package includes and package booking flows.                                                      |
| `octo/pickups`       | No       | [Pickups](/capabilities/pickups.md)                 | Pickup/dropoff fields on product/availability/booking.                                           |
| `octo/questions`     | No       | [Custom Questions](/capabilities/questions.md)      | Question schemas and `questionAnswers` write flows.                                              |
| `octo/waivers`       | No       | [Waivers](/capabilities/waivers.md)                 | Waiver templates on products and waiver submission/status fields on booking and unit-item flows. |
| `octo/resources`     | No       | [Resources](/capabilities/resources.md)             | Availability resources and resource allocations.                                                 |
| `octo/rentals`       | No       | [Rentals](/capabilities/rentals.md)                 | `rentalDurationId` behavior across product/availability/booking.                                 |
| `octo/redemption`    | No       | [Redemption](/capabilities/redemption.md)           | Redemption lookup, redeem/unredeem, no-show, and credential resolution flows.                    |
| `octo/mappings`      | No       | [Self-Service Mapping](/capabilities/mappings.md)   | Self-service mapping write/read flows.                                                           |
| `octo/cart`          | No       | [Multi-Booking Cart](/capabilities/cart.md)         | Order create/list/update/confirm/cancel flows.                                                   |
| `octo/gifts`         | No       | [Gift Vouchers](/capabilities/gift-vouchers.md)     | Gift voucher create/list/update/confirm/cancel flows.                                            |
| `octo/checkin`       | No       | [Online Check-in](/capabilities/online-check-in.md) | Check-in lookup and check-in fields on bookings/orders/gifts.                                    |
| `octo/cardPayments`  | No       | [Card Payments](/capabilities/card-payments.md)     | Card payment flows on booking/order/gift plus card payment lookup.                               |
| `octo/memberships`   | No       | [Memberships](/capabilities/memberships.md)         | Membership lookup and membership-booking listing.                                                |
| `octo/adjustments`   | No       | [Price Adjustments](/capabilities/adjustments.md)   | Extends booking create/update pricing inputs (`adjustments`).                                    |
| `octo/webhooks`      | No       | [Webhooks](/capabilities/webhooks.md)               | Webhook create/update/list/delete and trigger flows.                                             |
| `octo/waitlists`     | No       | [Waitlists](/capabilities/waitlists.md)             | Waitlist create flow.                                                                            |
| `octo/identities`    | Yes      | [Identities](/capabilities/identities.md)           | Identity create/update/delete and `identityId` linkage.                                          |
| `octo/campaigns`     | No       | [Campaigns](/capabilities/campaigns.md)             | Campaign listing endpoint support.                                                               |
| `octo/notifications` | No       | [Notifications](/capabilities/notifications.md)     | Notification subscription CRUD flows.                                                            |

## Capability Object Shape

Capabilities returned on product payloads and `/octo/capabilities` use this shape:

| Field          | Description                                          |
| -------------- | ---------------------------------------------------- |
| `id`           | Capability ID to include in `Octo-Capabilities`.     |
| `revision`     | Supported, backward-compatible capability revision.  |
| `required`     | Whether capability is required to sell that product. |
| `dependencies` | Capability IDs that are auto-included when needed.   |
| `docs`         | Documentation URL when provided by the API.          |

## Supplying Capabilities

Send requested capability IDs in the `Octo-Capabilities` request header on any OCTO endpoint (or `X-Capabilities` as the legacy alias). Capability IDs are requested uniformly via headers across all endpoints.

The response echoes applied capabilities in the `Octo-Capabilities` response header.
