FreeTicket B2B API

FreeTicket B2B REST API for integrations and the CLI. Authentication is by API key (Authorization: Bearer <key> header or x-api-key); the active workspace is selected with the X-Workspace-Id header.

Scopes: each key is either read (GET/HEAD only) or write (additionally creates, edits, deletes, cancels, refunds and checks in). Self-service keys are issued as read. A read key calling a mutating method gets a 403. The machine-readable declaration lives at /.well-known/oauth-protected-resource (RFC 9728).

auth

• POST
  Start the Device Authorization Grant (RFC 8628)/auth/device/code
• POST
  CLI poll: exchanges the device_code for an API key once approved/auth/device/token
• POST
  Headless sign-up: creates the unverified account and sends the email/auth/signup

me

• POST
  Create your own workspace/tenant (self-serve)/workspaces
• GET
  Authenticated user, role and accessible workspaces/me

events

• GET
  List workspace events/events
• POST
  Create an event/events
• GET
  Get an event/events/{id}
• DELETE
  Delete an event (soft delete)/events/{id}
• PATCH
  Update an event/events/{id}
• POST
  Publish an event/events/{id}/publish
• POST
  Cancel an event (keeps the record and its sales)/events/{id}/cancel
• GET
  List an event's dates/events/{id}/dates
• POST
  Add a date to an event/events/{id}/dates
• DELETE
  Delete an event date/events/{id}/dates/{dateId}
• PATCH
  Update an event date/events/{id}/dates/{dateId}

ticket-types

• GET
  List workspace ticket types/ticket-types
• POST
  Create a ticket type/ticket-types
• GET
  Get a ticket type/ticket-types/{id}
• DELETE
  Delete a ticket type (soft delete)/ticket-types/{id}
• PATCH
  Update a ticket type/ticket-types/{id}

sales

• GET
  List workspace sales/sales
• POST
  Create a sale/order (complimentary tickets and programmatic sales)/sales
• GET
  Get a sale with its items/sales/{id}
• POST
  Cancel a sale (blocked if someone already checked in or the payment is still open)/sales/{id}/cancel
• POST
  Refund a sale (moving the funds depends on the payment gateway)/sales/{id}/refund
• GET
  List the individual tickets of a sale/sales/{id}/tickets
• GET
  List a sale's payment attempt history/sales/{id}/attempts

membership-plans

• GET
  List the workspace's membership plans/membership-plans
• POST
  Create a membership plan/membership-plans
• GET
  Get a membership plan/membership-plans/{id}
• DELETE
  Delete a membership plan (soft delete)/membership-plans/{id}
• PATCH
  Update a membership plan/membership-plans/{id}
• GET
  List subscribers of a membership plan/membership-plans/{id}/subscribers

venues

• GET
  List workspace venues/venues
• POST
  Create a venue/venues
• GET
  Get a venue/venues/{id}
• DELETE
  Delete a venue (soft delete)/venues/{id}
• PATCH
  Update a venue/venues/{id}

staff

• GET
  List staff with access to the workspace/staff
• POST
  Create a staff user in the workspace/staff
• GET
  Get a staff member/staff/{id}
• DELETE
  Revoke a staff member's access to this workspace/staff/{id}
• PATCH
  Change a staff user's role/staff/{id}/role

reports

• GET
  Workspace KPIs (revenue, tickets, sales, memberships)/reports/summary
• GET
  Inventory aggregated by event/date/ticket type (capacity, sold, available)/reports/inventory
• GET
  CFO financial reconciliation (MP ↔ sale ↔ Siigo invoice)/reports/reconciliation
• GET
  CSV export of the CFO financial reconciliation/reports/exports/reconciliation
• GET
  Export attendees per ticket, with filters (max 5000)/reports/exports/attendees
• GET
  Export buyers, with filters (max 5000)/reports/exports/buyers
• GET
  Export subscribers (max 5000)/reports/exports/subscribers
• GET
  Sales KPIs per workspace event/reports/by-event
• GET
  Time series of CONFIRMED sales per bucket (day|week|month)/reports/timeseries
• GET
  Financial statement per event date: gross, costs, and net payable/reports/financials

settlements

• GET
  Workspace settlements (payouts to the organizer)/settlements
• GET
  Get a settlement/settlements/{id}
• GET
  Download a settlement PDF/settlements/{id}/document
• GET
  Download a settlement payment proof/settlements/{id}/proofs/{fileName}

discounts

• GET
  List workspace discount codes/discounts
• POST
  Create a discount code/discounts
• DELETE
  Delete a discount code (soft delete)/discounts/{id}
• PATCH
  Update a discount code/discounts/{id}

webhooks

• GET
  List workspace webhooks/webhooks
• POST
  Create a webhook (returns the signingSecret only once)/webhooks
• DELETE
  Delete a workspace webhook/webhooks/{id}
• PATCH
  Edit a webhook without rotating its signing secret/webhooks/{id}

subscriptions

• POST
  Cancel a membership subscription/subscriptions/{id}/cancel

tickets

• PATCH
  Reassign a sold ticket to another date or ticket type/tickets/{ticketCode}
• POST
  Check in a ticket at the door/tickets/{ticketCode}/checkin
• GET
  Check a ticket's validity without consuming it/tickets/{ticketCode}/access
• POST
  Resend the confirmation email with the ticket/tickets/{ticketCode}/resend

api-keys

• GET
  List my API keys/api-keys
• POST
  Mint an API key (returns the plaintext exactly once)/api-keys
• DELETE
  Revoke one of my API keys/api-keys/{id}

customer

• POST
  Request an access code to sign in (or create an account)/customer/auth/request
• POST
  Exchange the access code for a buyer session/customer/auth/verify
• GET
  Authenticated buyer identity/customer/me
• GET
  Buyer's tickets/customer/tickets
• GET
  Detail of a buyer's ticket (deep link)/customer/tickets/{id}
• POST
  Cancel the buyer's own purchase (only if not yet paid)/customer/tickets/{id}/cancel
• POST
  Sign out the buyer session/customer/logout
• POST
  Exchange the headless SSO one-time token for a session token/api/customer-auth/enterprise-exchange
• GET
  Buyer membership status in a workspace/customer/membership
• POST
  Start a membership sign-up (returns the payment URL)/customer/subscriptions
• POST
  Cancel the buyer's own membership/customer/subscriptions/cancel
• GET
  Buyer profile (name and phone)/customer/profile
• PATCH
  Update the buyer profile/customer/profile
• POST
  Open the purchase session (only one live per buyer)/customer/purchase-sessions
• GET
  Purchase session status/customer/purchase-sessions/{id}
• POST
  Release the seats of a purchase session/customer/purchase-sessions/{id}/release
• GET
  The purchase the buyer left unfinished for this event date/customer/orders
• POST
  Create the ticket reservation (step 1 of the headless purchase)/customer/orders
• POST
  Open payment for a reservation (Bold or MercadoPago, depending on the event)/customer/orders/{id}/payment
• POST
  Charge with the MercadoPago Payment Brick token/customer/orders/{id}/payment/card
• POST
  Open a PSE payment through MercadoPago (redirect)/customer/orders/{id}/payment/pse
• POST
  Release a reservation the buyer will not pay for/customer/orders/{id}/release
• GET
  Status of a headless purchase (and its tickets, once paid)/customer/orders/{id}

content

• GET
  List the organization's published videos/content/videos
• GET
  List the organization's community feed/content/posts
• POST
  Publish community content (including articles)/content/posts
• GET
  List the organization's live streams/content/lives
• GET
  Live stream status/content/lives/{id}
• POST
  Signed token to play a video or a live stream/content/playback-token