# API reference

> Every REST operation of the bymundi API, grouped by area.

Every REST operation, grouped by area. The same list, machine-readable, is the [OpenAPI document](https://api.bymundi.com/v1/openapi.json).

## Account

- [Who am I](https://api.bymundi.com/docs/reference/me.get.md) — `GET /v1/me`

## Catalog

- [Search or browse the catalog](https://api.bymundi.com/docs/reference/catalog.entities.list.md) — `GET /v1/catalog/entities`
- [Get a catalog entry](https://api.bymundi.com/docs/reference/catalog.entities.get.md) — `GET /v1/catalog/entities/{entityId}`
- [Search or browse the block library](https://api.bymundi.com/docs/reference/library.entries.list.md) — `GET /v1/library/entries`
- [Get a library block](https://api.bymundi.com/docs/reference/library.entries.get.md) — `GET /v1/library/entries/{entryId}`
- [Search or browse trip templates](https://api.bymundi.com/docs/reference/catalog.tripTemplates.list.md) — `GET /v1/trip-templates`
- [Get a trip template](https://api.bymundi.com/docs/reference/catalog.tripTemplates.get.md) — `GET /v1/trip-templates/{templateId}`
- [Create a catalog entry](https://api.bymundi.com/docs/reference/catalog.entities.create.md) — `POST /v1/catalog/entities`
- [Update a catalog entry](https://api.bymundi.com/docs/reference/catalog.entities.update.md) — `PATCH /v1/catalog/entities/{entityId}`
- [Delete a catalog entry](https://api.bymundi.com/docs/reference/catalog.entities.delete.md) — `DELETE /v1/catalog/entities/{entityId}`
- [Restore a deleted catalog entry](https://api.bymundi.com/docs/reference/catalog.entities.restore.md) — `POST /v1/catalog/entities/{entityId}/restore`
- [List the agency's rasgos](https://api.bymundi.com/docs/reference/catalog.features.list.md) — `GET /v1/catalog/features`
- [Start a catalog photo upload](https://api.bymundi.com/docs/reference/catalog.images.startUpload.md) — `POST /v1/catalog/entities/{entityId}/images`
- [Complete a catalog photo upload](https://api.bymundi.com/docs/reference/catalog.images.completeUpload.md) — `POST /v1/catalog/entities/{entityId}/images/{assetId}/complete`
- [List routes](https://api.bymundi.com/docs/reference/catalog.routes.list.md) — `GET /v1/catalog/routes`
- [Get a route](https://api.bymundi.com/docs/reference/catalog.routes.get.md) — `GET /v1/catalog/routes/{routeId}`
- [Create a route](https://api.bymundi.com/docs/reference/catalog.routes.create.md) — `POST /v1/catalog/routes`
- [Update a route](https://api.bymundi.com/docs/reference/catalog.routes.update.md) — `PATCH /v1/catalog/routes/{routeId}`
- [Delete a route](https://api.bymundi.com/docs/reference/catalog.routes.delete.md) — `DELETE /v1/catalog/routes/{routeId}`
- [Save a block to the library](https://api.bymundi.com/docs/reference/library.entries.create.md) — `POST /v1/library/entries`
- [Update a library block](https://api.bymundi.com/docs/reference/library.entries.update.md) — `PATCH /v1/library/entries/{entryId}`
- [Delete a library block](https://api.bymundi.com/docs/reference/library.entries.delete.md) — `DELETE /v1/library/entries/{entryId}`
- [Save a trip as a template](https://api.bymundi.com/docs/reference/catalog.tripTemplates.create.md) — `POST /v1/trip-templates`
- [Update a trip template](https://api.bymundi.com/docs/reference/catalog.tripTemplates.update.md) — `PATCH /v1/trip-templates/{templateId}`
- [Delete a trip template](https://api.bymundi.com/docs/reference/catalog.tripTemplates.delete.md) — `DELETE /v1/trip-templates/{templateId}`

## Changes

- [List changes](https://api.bymundi.com/docs/reference/changes.list.md) — `GET /v1/changes`
- [Get a change](https://api.bymundi.com/docs/reference/changes.get.md) — `GET /v1/changes/{changeId}`
- [Undo a change](https://api.bymundi.com/docs/reference/changes.revert.md) — `POST /v1/changes/{changeId}/revert`

## Documents

- [List documents](https://api.bymundi.com/docs/reference/documents.list.md) — `GET /v1/documents`
- [List a trip's documents](https://api.bymundi.com/docs/reference/documents.listForTrip.md) — `GET /v1/trips/{tripId}/documents`
- [Get a document](https://api.bymundi.com/docs/reference/documents.get.md) — `GET /v1/documents/{documentId}`
- [Get a document's download link](https://api.bymundi.com/docs/reference/documents.download.md) — `GET /v1/documents/{documentId}/download`
- [Start a document upload](https://api.bymundi.com/docs/reference/documents.startUpload.md) — `POST /v1/trips/{tripId}/documents`
- [Complete a document upload](https://api.bymundi.com/docs/reference/documents.completeUpload.md) — `POST /v1/documents/{documentId}/complete`
- [Update a document](https://api.bymundi.com/docs/reference/documents.update.md) — `PATCH /v1/documents/{documentId}`
- [Delete a document](https://api.bymundi.com/docs/reference/documents.delete.md) — `DELETE /v1/documents/{documentId}`
- [List a trip's document folders](https://api.bymundi.com/docs/reference/documents.folders.list.md) — `GET /v1/trips/{tripId}/document-folders`
- [Create a document folder](https://api.bymundi.com/docs/reference/documents.folders.create.md) — `POST /v1/trips/{tripId}/document-folders`
- [Rename a document folder](https://api.bymundi.com/docs/reference/documents.folders.update.md) — `PATCH /v1/document-folders/{folderId}`
- [Delete a document folder](https://api.bymundi.com/docs/reference/documents.folders.delete.md) — `DELETE /v1/document-folders/{folderId}`

## Itinerary

- [Get a trip's itinerary](https://api.bymundi.com/docs/reference/itinerary.get.md) — `GET /v1/trips/{tripId}/itinerary`
- [Get one block](https://api.bymundi.com/docs/reference/itinerary.getBlock.md) — `GET /v1/trips/{tripId}/itinerary/blocks/{blockId}`
- [Change the itinerary](https://api.bymundi.com/docs/reference/itinerary.applyOps.md) — `POST /v1/trips/{tripId}/itinerary/ops`
- [Sync the itinerary with the design](https://api.bymundi.com/docs/reference/itinerary.sync.md) — `POST /v1/trips/{tripId}/itinerary/sync`

## Quote templates

- [List quote templates](https://api.bymundi.com/docs/reference/quotes.templates.list.md) — `GET /v1/quote-templates`
- [Get a quote template](https://api.bymundi.com/docs/reference/quotes.templates.get.md) — `GET /v1/quote-templates/{templateId}`

## Quotes

- [List quotes](https://api.bymundi.com/docs/reference/quotes.list.md) — `GET /v1/quotes`
- [List a trip's quotes](https://api.bymundi.com/docs/reference/quotes.listForTrip.md) — `GET /v1/trips/{tripId}/quotes`
- [Get a quote](https://api.bymundi.com/docs/reference/quotes.get.md) — `GET /v1/quotes/{quoteId}`
- [Create a quote](https://api.bymundi.com/docs/reference/quotes.create.md) — `POST /v1/trips/{tripId}/quotes`
- [Update a quote](https://api.bymundi.com/docs/reference/quotes.update.md) — `PATCH /v1/quotes/{quoteId}`
- [Edit a quote's lines and packages](https://api.bymundi.com/docs/reference/quotes.editLines.md) — `POST /v1/quotes/{quoteId}/lines`
- [Sync a quote with the trip's design](https://api.bymundi.com/docs/reference/quotes.syncDesign.md) — `POST /v1/quotes/{quoteId}/sync-design`
- [Send a quote](https://api.bymundi.com/docs/reference/quotes.send.md) — `POST /v1/quotes/{quoteId}/send`
- [Accept a quote on the customer's behalf](https://api.bymundi.com/docs/reference/quotes.accept.md) — `POST /v1/quotes/{quoteId}/accept`
- [Reject a quote on the customer's behalf](https://api.bymundi.com/docs/reference/quotes.reject.md) — `POST /v1/quotes/{quoteId}/reject`
- [Reopen a quote](https://api.bymundi.com/docs/reference/quotes.reopen.md) — `POST /v1/quotes/{quoteId}/reopen`
- [Delete a quote](https://api.bymundi.com/docs/reference/quotes.delete.md) — `DELETE /v1/quotes/{quoteId}`

## Travelers

- [Get a trip's travelers](https://api.bymundi.com/docs/reference/travelers.roster.get.md) — `GET /v1/trips/{tripId}/travelers`
- [Get a traveler](https://api.bymundi.com/docs/reference/travelers.get.md) — `GET /v1/travelers/{travelerId}`
- [List travelers](https://api.bymundi.com/docs/reference/travelers.list.md) — `GET /v1/travelers`
- [Get a trip's booking contact](https://api.bymundi.com/docs/reference/travelers.contact.get.md) — `GET /v1/trips/{tripId}/contact`
- [Add a traveler](https://api.bymundi.com/docs/reference/travelers.add.md) — `POST /v1/trips/{tripId}/travelers`
- [Update a traveler](https://api.bymundi.com/docs/reference/travelers.update.md) — `PATCH /v1/travelers/{travelerId}`
- [Remove a traveler](https://api.bymundi.com/docs/reference/travelers.remove.md) — `DELETE /v1/travelers/{travelerId}`
- [Add the booking contact](https://api.bymundi.com/docs/reference/travelers.contact.create.md) — `POST /v1/trips/{tripId}/contact`
- [Update the booking contact](https://api.bymundi.com/docs/reference/travelers.contact.update.md) — `PATCH /v1/trips/{tripId}/contact`
- [Remove the booking contact](https://api.bymundi.com/docs/reference/travelers.contact.remove.md) — `DELETE /v1/trips/{tripId}/contact`
- [Resend an access email](https://api.bymundi.com/docs/reference/travelers.access.resend.md) — `POST /v1/trips/{tripId}/access/resend`

## Trips

- [List trips](https://api.bymundi.com/docs/reference/trips.list.md) — `GET /v1/trips`
- [List archived trips](https://api.bymundi.com/docs/reference/trips.listArchived.md) — `GET /v1/trips/archived`
- [Get a trip](https://api.bymundi.com/docs/reference/trips.get.md) — `GET /v1/trips/{tripId}`
- [Create a trip](https://api.bymundi.com/docs/reference/trips.create.md) — `POST /v1/trips`
- [Update a trip](https://api.bymundi.com/docs/reference/trips.update.md) — `PATCH /v1/trips/{tripId}`
- [Archive a trip](https://api.bymundi.com/docs/reference/trips.archive.md) — `DELETE /v1/trips/{tripId}`
- [Restore an archived trip](https://api.bymundi.com/docs/reference/trips.restore.md) — `POST /v1/trips/{tripId}/restore`
- [Duplicate a trip](https://api.bymundi.com/docs/reference/trips.duplicate.md) — `POST /v1/trips/{tripId}/duplicate`
- [Publish a trip](https://api.bymundi.com/docs/reference/trips.publish.md) — `POST /v1/trips/{tripId}/publish`
- [Unpublish a trip](https://api.bymundi.com/docs/reference/trips.unpublish.md) — `POST /v1/trips/{tripId}/unpublish`
- [Set a trip's commercial state](https://api.bymundi.com/docs/reference/trips.setCommercialState.md) — `POST /v1/trips/{tripId}/commercial-state`

## Webhooks

- [List webhook endpoints](https://api.bymundi.com/docs/reference/webhooks.endpoints.list.md) — `GET /v1/webhook-endpoints`
- [Create a webhook endpoint](https://api.bymundi.com/docs/reference/webhooks.endpoints.create.md) — `POST /v1/webhook-endpoints`
- [Get a webhook endpoint](https://api.bymundi.com/docs/reference/webhooks.endpoints.get.md) — `GET /v1/webhook-endpoints/{endpointId}`
- [Update a webhook endpoint](https://api.bymundi.com/docs/reference/webhooks.endpoints.update.md) — `PATCH /v1/webhook-endpoints/{endpointId}`
- [Delete a webhook endpoint](https://api.bymundi.com/docs/reference/webhooks.endpoints.delete.md) — `DELETE /v1/webhook-endpoints/{endpointId}`
- [Rotate a webhook endpoint's secret](https://api.bymundi.com/docs/reference/webhooks.endpoints.rotateSecret.md) — `POST /v1/webhook-endpoints/{endpointId}/rotate-secret`
- [Send a test event](https://api.bymundi.com/docs/reference/webhooks.endpoints.test.md) — `POST /v1/webhook-endpoints/{endpointId}/test`
- [List an endpoint's deliveries](https://api.bymundi.com/docs/reference/webhooks.deliveries.list.md) — `GET /v1/webhook-endpoints/{endpointId}/deliveries`
- [Resend a delivery](https://api.bymundi.com/docs/reference/webhooks.deliveries.resend.md) — `POST /v1/webhook-endpoints/{endpointId}/deliveries/{deliveryId}/resend`
- [List events](https://api.bymundi.com/docs/reference/events.list.md) — `GET /v1/events`
- [Get an event](https://api.bymundi.com/docs/reference/events.get.md) — `GET /v1/events/{eventId}`