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.

#Account

• Who am I — GET /v1/me

#Catalog

• Search or browse the catalog — GET /v1/catalog/entities
• Get a catalog entry — GET /v1/catalog/entities/{entityId}
• Search or browse the block library — GET /v1/library/entries
• Get a library block — GET /v1/library/entries/{entryId}
• Search or browse trip templates — GET /v1/trip-templates
• Get a trip template — GET /v1/trip-templates/{templateId}
• Create a catalog entry — POST /v1/catalog/entities
• Update a catalog entry — PATCH /v1/catalog/entities/{entityId}
• Delete a catalog entry — DELETE /v1/catalog/entities/{entityId}
• Restore a deleted catalog entry — POST /v1/catalog/entities/{entityId}/restore
• List the agency's rasgos — GET /v1/catalog/features
• Start a catalog photo upload — POST /v1/catalog/entities/{entityId}/images
• Complete a catalog photo upload — POST /v1/catalog/entities/{entityId}/images/{assetId}/complete
• List routes — GET /v1/catalog/routes
• Get a route — GET /v1/catalog/routes/{routeId}
• Create a route — POST /v1/catalog/routes
• Update a route — PATCH /v1/catalog/routes/{routeId}
• Delete a route — DELETE /v1/catalog/routes/{routeId}
• Save a block to the library — POST /v1/library/entries
• Update a library block — PATCH /v1/library/entries/{entryId}
• Delete a library block — DELETE /v1/library/entries/{entryId}
• Save a trip as a template — POST /v1/trip-templates
• Update a trip template — PATCH /v1/trip-templates/{templateId}
• Delete a trip template — DELETE /v1/trip-templates/{templateId}

#Changes

• List changes — GET /v1/changes
• Get a change — GET /v1/changes/{changeId}
• Undo a change — POST /v1/changes/{changeId}/revert

#Documents

• List documents — GET /v1/documents
• List a trip's documents — GET /v1/trips/{tripId}/documents
• Get a document — GET /v1/documents/{documentId}
• Get a document's download link — GET /v1/documents/{documentId}/download
• Start a document upload — POST /v1/trips/{tripId}/documents
• Complete a document upload — POST /v1/documents/{documentId}/complete
• Update a document — PATCH /v1/documents/{documentId}
• Delete a document — DELETE /v1/documents/{documentId}
• List a trip's document folders — GET /v1/trips/{tripId}/document-folders
• Create a document folder — POST /v1/trips/{tripId}/document-folders
• Rename a document folder — PATCH /v1/document-folders/{folderId}
• Delete a document folder — DELETE /v1/document-folders/{folderId}

#Itinerary

• Get a trip's itinerary — GET /v1/trips/{tripId}/itinerary
• Get one block — GET /v1/trips/{tripId}/itinerary/blocks/{blockId}
• Change the itinerary — POST /v1/trips/{tripId}/itinerary/ops
• Sync the itinerary with the design — POST /v1/trips/{tripId}/itinerary/sync

#Quote templates

• List quote templates — GET /v1/quote-templates
• Get a quote template — GET /v1/quote-templates/{templateId}

#Quotes

• List quotes — GET /v1/quotes
• List a trip's quotes — GET /v1/trips/{tripId}/quotes
• Get a quote — GET /v1/quotes/{quoteId}
• Create a quote — POST /v1/trips/{tripId}/quotes
• Update a quote — PATCH /v1/quotes/{quoteId}
• Edit a quote's lines and packages — POST /v1/quotes/{quoteId}/lines
• Sync a quote with the trip's design — POST /v1/quotes/{quoteId}/sync-design
• Send a quote — POST /v1/quotes/{quoteId}/send
• Accept a quote on the customer's behalf — POST /v1/quotes/{quoteId}/accept
• Reject a quote on the customer's behalf — POST /v1/quotes/{quoteId}/reject
• Reopen a quote — POST /v1/quotes/{quoteId}/reopen
• Delete a quote — DELETE /v1/quotes/{quoteId}

#Travelers

• Get a trip's travelers — GET /v1/trips/{tripId}/travelers
• Get a traveler — GET /v1/travelers/{travelerId}
• List travelers — GET /v1/travelers
• Get a trip's booking contact — GET /v1/trips/{tripId}/contact
• Add a traveler — POST /v1/trips/{tripId}/travelers
• Update a traveler — PATCH /v1/travelers/{travelerId}
• Remove a traveler — DELETE /v1/travelers/{travelerId}
• Add the booking contact — POST /v1/trips/{tripId}/contact
• Update the booking contact — PATCH /v1/trips/{tripId}/contact
• Remove the booking contact — DELETE /v1/trips/{tripId}/contact
• Resend an access email — POST /v1/trips/{tripId}/access/resend

#Trips

• List trips — GET /v1/trips
• List archived trips — GET /v1/trips/archived
• Get a trip — GET /v1/trips/{tripId}
• Create a trip — POST /v1/trips
• Update a trip — PATCH /v1/trips/{tripId}
• Archive a trip — DELETE /v1/trips/{tripId}
• Restore an archived trip — POST /v1/trips/{tripId}/restore
• Duplicate a trip — POST /v1/trips/{tripId}/duplicate
• Publish a trip — POST /v1/trips/{tripId}/publish
• Unpublish a trip — POST /v1/trips/{tripId}/unpublish
• Set a trip's commercial state — POST /v1/trips/{tripId}/commercial-state

#Webhooks

• List webhook endpoints — GET /v1/webhook-endpoints
• Create a webhook endpoint — POST /v1/webhook-endpoints
• Get a webhook endpoint — GET /v1/webhook-endpoints/{endpointId}
• Update a webhook endpoint — PATCH /v1/webhook-endpoints/{endpointId}
• Delete a webhook endpoint — DELETE /v1/webhook-endpoints/{endpointId}
• Rotate a webhook endpoint's secret — POST /v1/webhook-endpoints/{endpointId}/rotate-secret
• Send a test event — POST /v1/webhook-endpoints/{endpointId}/test
• List an endpoint's deliveries — GET /v1/webhook-endpoints/{endpointId}/deliveries
• Resend a delivery — POST /v1/webhook-endpoints/{endpointId}/deliveries/{deliveryId}/resend
• List events — GET /v1/events
• Get an event — GET /v1/events/{eventId}