Developer documentation
The REST API and MCP server let buyers and organizers read their own tickets and orders; organizers can also manage events, ticket tiers, attendees, check-in, and refunds. They are free on every plan.
Get an API key
Active accounts can create keys from the Account page → API Access. A key is shown once; choose scopes, set an optional expiry, and revoke it there. High-risk scopes are unchecked by default.
Personal ticket access
The tickets:read scope reads your own tickets and orders. Purchase statuses are active (2), cancelled under the Refund Guarantee (8), or refunded by the organizer (9); cancelled_at is present only for status 8. Refund amounts come from the latest status-2 refund log. The optional high-risk tickets:codes scope adds ticket codes and eligible online or recording links. These scopes do not allow purchases, refunds, or Guarantee cancellations.
Authentication
Send the key in the Bearer authorization header.
curl -H "Authorization: Bearer tp_YOUR_API_KEY" https://www.ticketplace.vip/api/v1/accountBase URL: https://www.ticketplace.vip/api/v1
Scopes
| Scope | Access | Account | Enabled by default |
|---|---|---|---|
tickets:read | Read my tickets and orders | Active account | Yes |
tickets:codes | Ticket codes and join links | Active account | No |
events:read | Read organizer account and events | Organizer | Yes |
events:write | Create and edit events | Organizer | Yes |
attendees:read | Read attendees and orders | Organizer | Yes |
checkin:write | Redeem tickets | Organizer | Yes |
payments:write | Refund orders | Organizer | No |
delete | Delete photos or deactivate events | Organizer | No |
Safety and limits
- Write operations that change data use preview/confirm where supported.
- Use
Idempotency-Keyfor safe retries of supported writes. - Rate limit: 60 requests per minute per API key.
- Daily cap: 20 confirmed refunds per organizer.
- API requests are audit-logged without request or response bodies.
- Human-only actions not in the API: coupons, attendee messaging, per-date add/remove, featured events, venue editing, Stripe Connect onboarding and payouts, API-key management, password changes, and account deletion.
Pagination and errors
List endpoints use limit and cursor where documented. Responses include next_cursor when another page is available. Errors use an error object; validation details may also be returned in errors.
{
"error": {
"code": "validation_error",
"message": "The request could not be processed."
},
"errors": { "name": "This field is required." }
}REST endpoint reference
Generated from the current OpenAPI document at request time. See OpenAPI 3.1 JSON.
Account
| Method | Path | Summary | Scope |
|---|---|---|---|
| GET | /account | Get the authenticated organizer profile | events:read |
Personal tickets
| Method | Path | Summary | Scope |
|---|---|---|---|
| GET | /me | Get the authenticated account and API key scopes | tickets:read |
| GET | /me/tickets | List the authenticated account's own ticket purchases | tickets:read |
| GET | /me/tickets/{purchase_id} | Get one of the authenticated account's own ticket purchases | tickets:read |
Events
| Method | Path | Summary | Scope |
|---|---|---|---|
| GET | /events | List the authenticated organizer's events | events:read |
| POST | /events | Create a complete draft event | events:write |
| GET | /events/{event_id} | Get an organizer-owned event | events:read |
| PATCH | /events/{event_id} | Update editable event details | events:write |
| POST | /events/{event_id}/deactivate | Preview or deactivate an event | events:write + delete |
| POST | /events/{event_id}/photos | Upload an event photo | events:write |
| DELETE | /events/{event_id}/photos/{photo_id} | Preview or delete an event photo | events:write + delete |
| POST | /events/{event_id}/publish | Preview or publish an event | events:write |
| PATCH | /events/{event_id}/tiers/{tier_id} | Update ticket tier details and price | events:write |
| GET | /events/{event_id}/videos | List an event's videos | events:read |
| POST | /events/{event_id}/videos | Add a YouTube or Vimeo video | events:write |
| DELETE | /events/{event_id}/videos/{video_id} | Preview or delete an event video | events:write |
Attendees
| Method | Path | Summary | Scope |
|---|---|---|---|
| GET | /events/{event_id}/attendees | List attendees for an owned event | attendees:read |
Orders
| Method | Path | Summary | Scope |
|---|---|---|---|
| POST | /check-in | Redeem a ticket | checkin:write |
| GET | /orders/{purchase_id} | Get an organizer-owned order | attendees:read |
| POST | /orders/{purchase_id}/refund | Preview or refund an order | payments:write |
Connect your AI tool (MCP)
MCP URL: https://www.ticketplace.vip/mcp
Most AI tools connect by signing in: add the URL, sign in to Ticket Place when asked, and choose the permissions. High-risk permissions start unchecked, and no API key is needed. You can revoke a connection at any time under Account → API Access → Connected apps.
Once connected, name Ticket Place in your request so the AI uses it instead of searching the web, for example: Use Ticket Place to list my upcoming events. Do not search the web.
ChatGPT, ChatGPT Work and dots
- On the ChatGPT website (not the mobile app), open chatgpt.com/plugins.
- Click +, then Add custom MCP server.
- Name: Ticket Place. Server URL:
https://www.ticketplace.vip/mcp. Authentication: OAuth. Leave the client ID and secret empty. - Select I understand and want to continue, then Create as a plugin.
- Install the plugin, sign in to Ticket Place and approve access.
- In a chat, type @ and choose Ticket Place.
When new tools are added, refresh the plugin in its settings. Details: OpenAI custom MCP server guide.
Dots: your ChatGPT dots use the same plugin. Once it is installed in the ChatGPT Plugins tab, your dot can use it within the permissions you approved; there is nothing extra to set up. See Dots FAQ.
Claude (claude.ai, Claude Desktop, Cowork and mobile)
- Open Customize → Connectors and click Add.
- Hover over Custom and select Web.
- Name: Ticket Place. Remote MCP server URL:
https://www.ticketplace.vip/mcp. Click Continue. - Authentication: Sign in now. OAuth client: Register automatically.
- Click Add, then sign in to Ticket Place and approve access.
A connector added once works in every Claude app. The Free plan allows one custom connector; on Team and Enterprise an owner adds it first. Details: Claude custom connectors.
Grok
- Open grok.com/connectors.
- Click New Connector, then select Custom.
- Enter the MCP server URL
https://www.ticketplace.vip/mcp, then sign in to Ticket Place and approve access.
On Grok Business and Enterprise, a team admin first adds the server in the xAI console under Grok Business → Connectors → Add Connector → Other; then each member connects on grok.com/connectors. Details: Grok connectors.
Claude Code
claude mcp add --transport http ticket-place https://www.ticketplace.vip/mcpThen run /mcp in Claude Code, select ticket-place and choose Authenticate. Add --scope user to use it in every project. Details: Claude Code MCP documentation.
Codex (CLI, IDE extension and ChatGPT desktop app)
codex mcp add ticket-place --url https://www.ticketplace.vip/mcp
codex mcp login ticket-placeThe login command opens your browser to sign in. The Codex CLI, IDE extension and ChatGPT desktop app share this setup in ~/.codex/config.toml. Details: Codex MCP documentation.
Cursor
Add this to ~/.cursor/mcp.json (all projects) or .cursor/mcp.json (one project):
{
"mcpServers" : {
"ticket-place" : {
"url" : "https://www.ticketplace.vip/mcp"
}
}
}
Restart Cursor, then sign in to Ticket Place when Cursor asks to connect the server. Details: Cursor MCP documentation.
VS Code (GitHub Copilot)
- Run Chat: Open Customizations and select MCP Servers.
- Click Add Server (+), choose HTTP and enter
https://www.ticketplace.vip/mcp. - Enter the server ID
ticket-place, select Global → Copilot Global, and complete the sign-in.
Or add it to ~/.copilot/mcp-config.json:
{
"mcpServers" : {
"ticket-place" : {
"tools" : [
"*"
],
"type" : "http",
"url" : "https://www.ticketplace.vip/mcp"
}
}
}
Details: VS Code MCP servers.
Devin
In the Devin web app, open Customize → MCPs and add a custom MCP server with transport HTTP, server URL https://www.ticketplace.vip/mcp, authentication OAuth and access Personal. Save it, then click Connect and sign in. For the Devin CLI:
devin mcp add ticket-place --url https://www.ticketplace.vip/mcp
devin mcp login ticket-placeDetails: Devin MCP documentation.
Meta Muse
Muse has no settings form for MCP servers. Paste this message into a Muse chat and approve the sign-in it shows you:
Create a Custom Connector for a remote MCP server and connect to it:
- Name: Ticket Place
- Transport: remote streamable HTTP
- URL: https://www.ticketplace.vip/mcp
- Auth: OAuth (sign in when prompted; there is no API key to paste)
Then list its tools to confirm the connection works, and save it as a reusable skill.Other MCP clients
Use Streamable HTTP at https://www.ticketplace.vip/mcp. The server supports OAuth 2.1 with discovery at /.well-known/oauth-protected-resource and dynamic client registration. Tools without OAuth can send an API key from Account → API Access as a bearer token, for example:
claude mcp add --transport http ticket-place https://www.ticketplace.vip/mcp --header "Authorization: Bearer tp_YOUR_API_KEY"For clients that only run local (stdio) servers, use the mcp-remote bridge:
{
"mcpServers" : {
"ticket-place" : {
"args" : [
"-y",
"mcp-remote",
"https://www.ticketplace.vip/mcp",
"--header",
"Authorization: Bearer tp_YOUR_API_KEY"
],
"command" : "npx"
}
}
}
Available tools: get_account, list_events, get_event, create_event_draft, update_event, update_ticket_tier, upload_event_photo, delete_event_photo, list_event_videos, add_event_video, delete_event_video, publish_event, deactivate_event, list_attendees, get_order, check_in_ticket, refund_order.