--- seo: description: >- FreeTicket B2B REST API for integrations and the CLI. Authentication is by API key (Authorization: Bearer header or x-api-key); the active workspace is… sidebar: label: Overview title: FreeTicket B2B API --- FreeTicket B2B REST API for integrations and the CLI. Authentication is by API key (`Authorization: Bearer ` 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). Version 1.16.1 Base URL: `https://admin.appfreeticket.com/api/v1` ## auth - [`POST /auth/device/code`](/reference/v1/auth/post-auth-device-code) — Start the Device Authorization Grant (RFC 8628). - [`POST /auth/device/token`](/reference/v1/auth/post-auth-device-token) — CLI poll: exchanges the device\_code for an API key once approved. - [`POST /auth/signup`](/reference/v1/auth/post-auth-signup) — Headless sign-up: creates the unverified account and sends the email. ## me - [`POST /workspaces`](/reference/v1/me/post-workspaces) — Create your own workspace/tenant (self-serve). - [`GET /me`](/reference/v1/me/get-me) — Authenticated user, role and accessible workspaces. ## events - [`GET /events`](/reference/v1/events/get-events) — List workspace events. - [`POST /events`](/reference/v1/events/post-events) — Create an event. - [`GET /events/{id}`](/reference/v1/events/get-events-id) — Get an event. - [`DELETE /events/{id}`](/reference/v1/events/delete-events-id) — Delete an event (soft delete). - [`PATCH /events/{id}`](/reference/v1/events/patch-events-id) — Update an event. - [`POST /events/{id}/publish`](/reference/v1/events/post-events-id-publish) — Publish an event. - [`POST /events/{id}/cancel`](/reference/v1/events/post-events-id-cancel) — Cancel an event (keeps the record and its sales). - [`GET /events/{id}/dates`](/reference/v1/events/get-events-id-dates) — List an event's dates. - [`POST /events/{id}/dates`](/reference/v1/events/post-events-id-dates) — Add a date to an event. - [`DELETE /events/{id}/dates/{dateId}`](/reference/v1/events/delete-events-id-dates-date-id) — Delete an event date. - [`PATCH /events/{id}/dates/{dateId}`](/reference/v1/events/patch-events-id-dates-date-id) — Update an event date. ## ticket-types - [`GET /ticket-types`](/reference/v1/ticket-types/get-ticket-types) — List workspace ticket types. - [`POST /ticket-types`](/reference/v1/ticket-types/post-ticket-types) — Create a ticket type. - [`GET /ticket-types/{id}`](/reference/v1/ticket-types/get-ticket-types-id) — Get a ticket type. - [`DELETE /ticket-types/{id}`](/reference/v1/ticket-types/delete-ticket-types-id) — Delete a ticket type (soft delete). - [`PATCH /ticket-types/{id}`](/reference/v1/ticket-types/patch-ticket-types-id) — Update a ticket type. ## sales - [`GET /sales`](/reference/v1/sales/get-sales) — List workspace sales. - [`POST /sales`](/reference/v1/sales/post-sales) — Create a sale/order (complimentary tickets and programmatic sales). - [`GET /sales/{id}`](/reference/v1/sales/get-sales-id) — Get a sale with its items. - [`POST /sales/{id}/cancel`](/reference/v1/sales/post-sales-id-cancel) — Cancel a sale (blocked if someone already checked in or the payment is still open). - [`POST /sales/{id}/refund`](/reference/v1/sales/post-sales-id-refund) — Refund a sale (moving the funds depends on the payment gateway). - [`GET /sales/{id}/tickets`](/reference/v1/sales/get-sales-id-tickets) — List the individual tickets of a sale. - [`GET /sales/{id}/attempts`](/reference/v1/sales/get-sales-id-attempts) — List a sale's payment attempt history. ## membership-plans - [`GET /membership-plans`](/reference/v1/membership-plans/get-membership-plans) — List the workspace's membership plans. - [`POST /membership-plans`](/reference/v1/membership-plans/post-membership-plans) — Create a membership plan. - [`GET /membership-plans/{id}`](/reference/v1/membership-plans/get-membership-plans-id) — Get a membership plan. - [`DELETE /membership-plans/{id}`](/reference/v1/membership-plans/delete-membership-plans-id) — Delete a membership plan (soft delete). - [`PATCH /membership-plans/{id}`](/reference/v1/membership-plans/patch-membership-plans-id) — Update a membership plan. - [`GET /membership-plans/{id}/subscribers`](/reference/v1/membership-plans/get-membership-plans-id-subscribers) — List subscribers of a membership plan. ## venues - [`GET /venues`](/reference/v1/venues/get-venues) — List workspace venues. - [`POST /venues`](/reference/v1/venues/post-venues) — Create a venue. - [`GET /venues/{id}`](/reference/v1/venues/get-venues-id) — Get a venue. - [`DELETE /venues/{id}`](/reference/v1/venues/delete-venues-id) — Delete a venue (soft delete). - [`PATCH /venues/{id}`](/reference/v1/venues/patch-venues-id) — Update a venue. ## staff - [`GET /staff`](/reference/v1/staff/get-staff) — List staff with access to the workspace. - [`POST /staff`](/reference/v1/staff/post-staff) — Create a staff user in the workspace. - [`GET /staff/{id}`](/reference/v1/staff/get-staff-id) — Get a staff member. - [`DELETE /staff/{id}`](/reference/v1/staff/delete-staff-id) — Revoke a staff member's access to this workspace. - [`PATCH /staff/{id}/role`](/reference/v1/staff/patch-staff-id-role) — Change a staff user's role. ## reports - [`GET /reports/summary`](/reference/v1/reports/get-reports-summary) — Workspace KPIs (revenue, tickets, sales, memberships). - [`GET /reports/inventory`](/reference/v1/reports/get-reports-inventory) — Inventory aggregated by event/date/ticket type (capacity, sold, available). - [`GET /reports/reconciliation`](/reference/v1/reports/get-reports-reconciliation) — CFO financial reconciliation (MP ↔ sale ↔ Siigo invoice). - [`GET /reports/exports/reconciliation`](/reference/v1/reports/get-reports-exports-reconciliation) — CSV export of the CFO financial reconciliation. - [`GET /reports/exports/attendees`](/reference/v1/reports/get-reports-exports-attendees) — Export attendees per ticket, with filters (max 5000). - [`GET /reports/exports/buyers`](/reference/v1/reports/get-reports-exports-buyers) — Export buyers, with filters (max 5000). - [`GET /reports/exports/subscribers`](/reference/v1/reports/get-reports-exports-subscribers) — Export subscribers (max 5000). - [`GET /reports/by-event`](/reference/v1/reports/get-reports-by-event) — Sales KPIs per workspace event. - [`GET /reports/timeseries`](/reference/v1/reports/get-reports-timeseries) — Time series of CONFIRMED sales per bucket (day|week|month). - [`GET /reports/financials`](/reference/v1/reports/get-reports-financials) — Financial statement per event date: gross, costs, and net payable. ## settlements - [`GET /settlements`](/reference/v1/settlements/get-settlements) — Workspace settlements (payouts to the organizer). - [`GET /settlements/{id}`](/reference/v1/settlements/get-settlements-id) — Get a settlement. - [`GET /settlements/{id}/document`](/reference/v1/settlements/get-settlements-id-document) — Download a settlement PDF. - [`GET /settlements/{id}/proofs/{fileName}`](/reference/v1/settlements/get-settlements-id-proofs-file-name) — Download a settlement payment proof. ## discounts - [`GET /discounts`](/reference/v1/discounts/get-discounts) — List workspace discount codes. - [`POST /discounts`](/reference/v1/discounts/post-discounts) — Create a discount code. - [`DELETE /discounts/{id}`](/reference/v1/discounts/delete-discounts-id) — Delete a discount code (soft delete). - [`PATCH /discounts/{id}`](/reference/v1/discounts/patch-discounts-id) — Update a discount code. ## webhooks - [`GET /webhooks`](/reference/v1/webhooks/get-webhooks) — List workspace webhooks. - [`POST /webhooks`](/reference/v1/webhooks/post-webhooks) — Create a webhook (returns the signingSecret only once). - [`DELETE /webhooks/{id}`](/reference/v1/webhooks/delete-webhooks-id) — Delete a workspace webhook. - [`PATCH /webhooks/{id}`](/reference/v1/webhooks/patch-webhooks-id) — Edit a webhook without rotating its signing secret. ## subscriptions - [`POST /subscriptions/{id}/cancel`](/reference/v1/subscriptions/post-subscriptions-id-cancel) — Cancel a membership subscription. ## tickets - [`PATCH /tickets/{ticketCode}`](/reference/v1/tickets/patch-tickets-ticket-code) — Reassign a sold ticket to another date or ticket type. - [`POST /tickets/{ticketCode}/checkin`](/reference/v1/tickets/post-tickets-ticket-code-checkin) — Check in a ticket at the door. - [`GET /tickets/{ticketCode}/access`](/reference/v1/tickets/get-tickets-ticket-code-access) — Check a ticket's validity without consuming it. - [`POST /tickets/{ticketCode}/resend`](/reference/v1/tickets/post-tickets-ticket-code-resend) — Resend the confirmation email with the ticket. ## api-keys - [`GET /api-keys`](/reference/v1/api-keys/get-api-keys) — List my API keys. - [`POST /api-keys`](/reference/v1/api-keys/post-api-keys) — Mint an API key (returns the plaintext exactly once). - [`DELETE /api-keys/{id}`](/reference/v1/api-keys/delete-api-keys-id) — Revoke one of my API keys. ## customer - [`POST /customer/auth/request`](/reference/v1/customer/post-customer-auth-request) — Request an access code to sign in (or create an account). - [`POST /customer/auth/verify`](/reference/v1/customer/post-customer-auth-verify) — Exchange the access code for a buyer session. - [`GET /customer/me`](/reference/v1/customer/get-customer-me) — Authenticated buyer identity. - [`GET /customer/tickets`](/reference/v1/customer/get-customer-tickets) — Buyer's tickets. - [`GET /customer/tickets/{id}`](/reference/v1/customer/get-customer-tickets-id) — Detail of a buyer's ticket (deep link). - [`POST /customer/tickets/{id}/cancel`](/reference/v1/customer/post-customer-tickets-id-cancel) — Cancel the buyer's own purchase (only if not yet paid). - [`POST /customer/logout`](/reference/v1/customer/post-customer-logout) — Sign out the buyer session. - [`POST /api/customer-auth/enterprise-exchange`](/reference/v1/customer/post-api-customer-auth-enterprise-exchange) — Exchange the headless SSO one-time token for a session token. - [`GET /customer/membership`](/reference/v1/customer/get-customer-membership) — Buyer membership status in a workspace. - [`POST /customer/subscriptions`](/reference/v1/customer/post-customer-subscriptions) — Start a membership sign-up (returns the payment URL). - [`POST /customer/subscriptions/cancel`](/reference/v1/customer/post-customer-subscriptions-cancel) — Cancel the buyer's own membership. - [`GET /customer/profile`](/reference/v1/customer/get-customer-profile) — Buyer profile (name and phone). - [`PATCH /customer/profile`](/reference/v1/customer/patch-customer-profile) — Update the buyer profile. - [`POST /customer/purchase-sessions`](/reference/v1/customer/post-customer-purchase-sessions) — Open the purchase session (only one live per buyer). - [`GET /customer/purchase-sessions/{id}`](/reference/v1/customer/get-customer-purchase-sessions-id) — Purchase session status. - [`POST /customer/purchase-sessions/{id}/release`](/reference/v1/customer/post-customer-purchase-sessions-id-release) — Release the seats of a purchase session. - [`GET /customer/orders`](/reference/v1/customer/get-customer-orders) — The purchase the buyer left unfinished for this event date. - [`POST /customer/orders`](/reference/v1/customer/post-customer-orders) — Create the ticket reservation (step 1 of the headless purchase). - [`POST /customer/orders/{id}/payment`](/reference/v1/customer/post-customer-orders-id-payment) — Open payment for a reservation (Bold or MercadoPago, depending on the event). - [`POST /customer/orders/{id}/payment/card`](/reference/v1/customer/post-customer-orders-id-payment-card) — Charge with the MercadoPago Payment Brick token. - [`POST /customer/orders/{id}/payment/pse`](/reference/v1/customer/post-customer-orders-id-payment-pse) — Open a PSE payment through MercadoPago (redirect). - [`POST /customer/orders/{id}/release`](/reference/v1/customer/post-customer-orders-id-release) — Release a reservation the buyer will not pay for. - [`GET /customer/orders/{id}`](/reference/v1/customer/get-customer-orders-id) — Status of a headless purchase (and its tickets, once paid). ## content - [`GET /content/videos`](/reference/v1/content/get-content-videos) — List the organization's published videos. - [`GET /content/posts`](/reference/v1/content/get-content-posts) — List the organization's community feed. - [`POST /content/posts`](/reference/v1/content/post-content-posts) — Publish community content (including articles). - [`GET /content/lives`](/reference/v1/content/get-content-lives) — List the organization's live streams. - [`GET /content/lives/{id}`](/reference/v1/content/get-content-lives-id) — Live stream status. - [`POST /content/playback-token`](/reference/v1/content/post-content-playback-token) — Signed token to play a video or a live stream.