TixFinDocs

AI client tool reference

Every TixFin tool that maps to one organiser API operation, with its permission, operations and whether it needs personal data

6 min read

This page lists every tool that calls one operation of the TixFin organiser API, generated from TixFin's tool manifest; the titles are the API's. A tool needs the permission of its section on the consent page. A tool that changes something answers with a proposal and changes nothing until you confirm it. Tools TixFin answers itself, such as event_plan, proposal_apply and api_call, are described on What your AI client can do.

A tool marked yes under Personal data also needs See buyers' personal data.

Read (tixfin.read)

ToolTitleOperationsPersonal data
attendance_getList attendance events for an event, newest firstGET /projects/{projectId}/events/{eventId}/attendanceyes
attribution_links_listList tracking links with their visits, orders and revenueGET /projects/{projectId}/attribution/linksyes
campaign_previewPreview resolved recipients before sendingPOST /projects/{projectId}/email-campaigns/previewyes
campaign_templates_listList templates visible for project (global + project + event)GET /projects/{projectId}/email-campaigns/templatesyes
checkin_lists_listList check-in lists for an eventGET /projects/{projectId}/events/{eventId}/check-in-listsyes
event_getGet a project event by idGET /projects/{projectId}/events/{eventId}β€”
events_attendanceList attendance counts for events in the projectGET /projects/{projectId}/events/attendanceβ€”
events_listList events for a project (paginated)GET /projects/{projectId}/eventsβ€”
events_wizard_presetsList event wizard presetsGET /projects/{projectId}/events/wizard-presetsβ€”
group_discounts_listList the project's active group discounts (quantity breaks)GET /projects/{projectId}/group-discountsβ€”
guest_list_links_listList the event's guest-list signup links with their countsGET /projects/{projectId}/events/{eventId}/guest-list-linksyes
journeys_listList a project's journeysGET /projects/{projectId}/journeysyes
lotteries_listList lotteries for eventGET /projects/{projectId}/events/{eventId}/lotteriesyes
newsletter_sync_statusRead the latest lines of the newsletter sync logGET /projects/{projectId}/newsletter-integration/logyes
order_getGet an order's lines, notes and ledger-derived balanceGET /projects/{projectId}/orders/{orderId}yes
orders_listList a project's ordersGET /projects/{projectId}/ordersyes
packages_listList a project's package definitions, optionally filtered by seasonGET /projects/{projectId}/packagesβ€”
products_listList a project's productsGET /projects/{projectId}/productsβ€”
project_getGibt ein einzelnes Projekt zurΓΌckGET /projects/{id}yes
report_exportRun a saved report definition and download it as CSV, XLSX or PDFGET /projects/{projectId}/report-definitions/{reportDefinitionId}/exportyes
reports_listList a project's saved report definitions (paged)GET /projects/{projectId}/report-definitionsyes
sales_heatmapA project's sales by date and time slotGET /projects/{projectId}/analytics/sales-heatmapβ€”
sales_summaryAn event's sales by ticket type and dayGET /projects/{projectId}/events/{eventId}/sales-summaryβ€”
seatmap_getGet the full seatmap layout (seatmap + sections + seats)GET /projects/{projectId}/venues/{venueId}/seatmaps/{seatmapId}/layoutβ€”
seatmap_templates_listList global seatmap templates for a projectGET /projects/{projectId}/venues/{venueId}/seatmaps/global-templatesβ€”
seatmap_validateValidate the seatmap layout server-side (errors, warnings, hints)GET /projects/{projectId}/venues/{venueId}/seatmaps/{seatmapId}/validateβ€”
shop_customization_getGet current shop customization for admin editingGET /projects/{projectId}/shop/customizationβ€”
shop_pages_listList shop pages for admin editingGET /projects/{projectId}/shop/pagesβ€”
tiers_listList ticket tiers for an event (effective by default)GET /tiers/projects/{projectId}/events/{eventId}/tiersβ€”
venues_listList venues for a project (paginated)GET /projects/{projectId}/venuesβ€”

Changes you confirm (tixfin.write)

ToolTitleOperationsPersonal data
attribution_link_archiveArchive a tracking linkPOST /projects/{projectId}/attribution/links/{linkId}/archiveyes
attribution_link_createCreate a tracking linkPOST /projects/{projectId}/attribution/linksyes
campaign_draftCreate a new email template; Update an email templatePOST /projects/{projectId}/email-campaigns/templates
PUT /projects/{projectId}/email-campaigns/templates/{templateId}
yes
event_createCreate a project eventPOST /projects/{projectId}/eventsβ€”
event_resume_salesResume sales for a postponed eventPOST /projects/{projectId}/events/{eventId}/resume-salesβ€”
event_updateUpdate a project eventPUT /projects/{projectId}/events/{eventId}β€”
journey_upsertCreate a journey; Update a journey's name, trigger or active flagPOST /projects/{projectId}/journeys
PUT /projects/{projectId}/journeys/{journeyId}
yes
lottery_upsertCreate lottery; UpdatePOST /projects/{projectId}/events/{eventId}/lotteries
PUT /projects/{projectId}/events/{eventId}/lotteries/{lotteryId}
yes
report_runRun a saved report definition now and return its computed rowsPOST /projects/{projectId}/report-definitions/{reportDefinitionId}/executeyes
seatmap_publishValidate and publish a seatmap, snapshotting it into a new revisionPOST /projects/{projectId}/venues/{venueId}/seatmaps/{seatmapId}/publishβ€”
shop_page_upsertCreate a shop page; Update a shop pagePOST /projects/{projectId}/shop/pages
PUT /projects/{projectId}/shop/pages/{pageId}
β€”
ticket_type_createCreate a ticket type for an eventPOST /projects/{projectId}/events/{eventId}/ticket-typesβ€”
tier_upsertCreate an event-scoped ticket tier; Update an event-scoped ticket tierPOST /tiers/projects/{projectId}/events/{eventId}/tiers
PUT /tiers/projects/{projectId}/events/{eventId}/tiers/{tierId}
β€”
venue_upsertCreate a venue; Update a venuePOST /projects/{projectId}/venues
PUT /projects/{projectId}/venues/{venueId}
β€”

A change above is a money proposal, which needs Take actions that move money or reach buyers and a second factor from the last ten minutes, when:

  • event_update: the request sets refundEnabled; the request sets refundFeePercent; the request sets refundCutoffMinutes; the request sets startsAt; the request sets seatmapId; the request sets venueCountry
  • ticket_type_create: eventId names one that exists already, not one the same proposal creates

Money and buyers (tixfin.money, with a fresh second factor)

ToolTitleOperationsPersonal data
campaign_sendSend campaign email to resolved recipientsPOST /projects/{projectId}/email-campaigns/sendyes
event_cancelCancel an event and pause salesPOST /projects/{projectId}/events/{eventId}/cancelβ€”
event_deleteDelete a project eventDELETE /projects/{projectId}/events/{eventId}β€”
event_postponePostpone an event and pause salesPOST /projects/{projectId}/events/{eventId}/postponeβ€”
external_admissions_importImport barcodes of tickets sold elsewhere, or check them with a dry runPOST /projects/{projectId}/events/{eventId}/external-admissions/importyes
group_discount_createCreate a group discount: from minQuantity tickets of one type in an order, each pays the reduced pricePOST /projects/{projectId}/group-discountsβ€”
group_discount_deleteSwitch a group discount offDELETE /projects/{projectId}/group-discounts/{discountId}β€”
guest_list_approveApprove or reject pending guest-list signups in bulk; each guest is mailed the answerPOST /projects/{projectId}/events/{eventId}/guest-list-signups/decideyes
guest_list_link_upsertCreate a capped guest-list signup link, optionally per promoter, with a deadlinePOST /projects/{projectId}/events/{eventId}/guest-list-linksyes
order_exchangeExchange an order line for a different seat category or performancePOST /projects/{projectId}/orders/{orderId}/exchangesyes
order_refundRefund an order, fully or partially, at the order-line levelPOST /projects/{projectId}/orders/{orderId}/refundsyes
package_upsertCreate a package definition, with its components and rules; Update a package definition, replacing its components and rulesPOST /projects/{projectId}/packages
PUT /projects/{projectId}/packages/{packageId}
β€”
product_upsertCreate a product; Update a productPOST /projects/{projectId}/products
PUT /projects/{projectId}/products/{productId}
β€”
seatmap_apply_templateApply a seatmap template and overwrite the full layoutPOST /projects/{projectId}/venues/{venueId}/seatmaps/{seatmapId}/apply-template/{templateSeatmapId}β€”
shop_customization_updateSave shop customization (does not publish)PUT /projects/{projectId}/shop/customizationβ€”

On this page