{"openapi":"3.0.3","info":{"title":"LiveArena API","version":"1.0.0-beta","description":"Read your events, ticket types, orders, tickets and check-ins, and create draft events. Part of the Enterprise plan. Every key reaches only the profile it was made for. Rate limit: 120 requests a minute per key."},"servers":[{"url":"https://api.livearena.ai/api/v1"}],"security":[{"apiKey":[]}],"paths":{"/events":{"get":{"summary":"List your events","x-required-scope":"events:read","parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"status","in":"query","schema":{"type":"string","enum":["DRAFT","ACTIVE","INACTIVE","CANCELLED","ARCHIVED"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"summary":"Create a draft event","x-required-scope":"events:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/Event"}}}}}},"400":{"$ref":"#/components/responses/Invalid"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/events/{eventId}":{"get":{"summary":"One of your events","x-required-scope":"events:read","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/Event"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}},"patch":{"summary":"Change a draft event","description":"Only a DRAFT can be changed. Publishing and moving to another venue are done in the dashboard.","x-required-scope":"events:write","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/Event"}}}}}},"400":{"$ref":"#/components/responses/Invalid"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"EVENT_NOT_DRAFT"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/events/{eventId}/ticket-types":{"get":{"summary":"An event's ticket types","x-required-scope":"events:read","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TicketType"}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/events/{eventId}/orders":{"get":{"summary":"An event's orders","description":"Each order carries `buyer` only when the key also has attendees:read.","x-required-scope":"orders:read","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/orders/{orderId}":{"get":{"summary":"One order","x-required-scope":"orders:read","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/Order"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/events/{eventId}/tickets":{"get":{"summary":"An event's issued tickets","description":"Tickets on confirmed orders. `holder` only when the key also has attendees:read.","x-required-scope":"tickets:read","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/IssuedTicket"}},"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/events/{eventId}/check-ins":{"get":{"summary":"An event's door scans","x-required-scope":"tickets:read","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CheckIn"}},"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Authorization: Bearer lak_... Made in the dashboard under API & webhooks."}},"responses":{"Unauthorized":{"description":"UNAUTHORIZED: missing, unknown or revoked key"},"Forbidden":{"description":"INSUFFICIENT_SCOPE, or FEATURE_NOT_AVAILABLE when the profile is not on Enterprise"},"NotFound":{"description":"NOT_FOUND, including another profile's records"},"RateLimited":{"description":"More than 120 requests in a minute with this key"},"Invalid":{"description":"VALIDATION_ERROR"}},"schemas":{"Person":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}}},"Event":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","ACTIVE","INACTIVE","CANCELLED","ARCHIVED"]},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time","nullable":true},"timezone":{"type":"string","nullable":true},"allDay":{"type":"boolean"},"address":{"type":"string"},"city":{"type":"string","nullable":true},"placeId":{"type":"string","format":"uuid"},"ticketMode":{"type":"string","enum":["LIVEARENA","EXTERNAL","FREE"]},"imageUrl":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"EventCreate":{"type":"object","required":["name","description","address","lat","lng","categories","placeId","eventStartsAt"],"additionalProperties":false,"properties":{"name":{"type":"string"},"description":{"type":"string"},"address":{"type":"string"},"lat":{"type":"number"},"lng":{"type":"number"},"categories":{"type":"array","items":{"type":"string"},"minItems":1},"placeId":{"type":"string","format":"uuid","description":"One of your venues"},"eventStartsAt":{"type":"string","format":"date-time"},"eventEndsAt":{"type":"string","format":"date-time"},"timezone":{"type":"string","example":"America/New_York"},"email":{"type":"string","format":"email"},"website":{"type":"string","format":"uri"},"phoneNumber":{"type":"string"},"city":{"type":"string"},"ticketMode":{"type":"string","enum":["LIVEARENA","EXTERNAL","FREE"]},"ticketUrl":{"type":"string","format":"uri"},"offersVipTables":{"type":"boolean"}}},"EventUpdate":{"type":"object","additionalProperties":false,"description":"Any field of EventCreate except placeId.","properties":{"name":{"type":"string"},"description":{"type":"string"},"address":{"type":"string"},"eventStartsAt":{"type":"string","format":"date-time"},"eventEndsAt":{"type":"string","format":"date-time"},"timezone":{"type":"string"},"ticketMode":{"type":"string","enum":["LIVEARENA","EXTERNAL","FREE"]}}},"TicketType":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"kind":{"type":"string","enum":["STANDARD","TABLE"]},"partySize":{"type":"integer","nullable":true},"price":{"type":"string","example":"20.00","description":"USD"},"quantity":{"type":"integer"},"sold":{"type":"integer"},"salesEndAt":{"type":"string","format":"date-time","nullable":true},"isActive":{"type":"boolean"}}},"Order":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"eventId":{"type":"string","format":"uuid"},"status":{"type":"string"},"totalAmount":{"type":"string","example":"40.00"},"currency":{"type":"string","example":"USD"},"createdAt":{"type":"string","format":"date-time"},"checkedIn":{"type":"boolean"},"checkedInAt":{"type":"string","format":"date-time","nullable":true},"items":{"type":"array","items":{"type":"object","properties":{"ticketTypeId":{"type":"string","nullable":true},"quantity":{"type":"integer"},"unitPrice":{"type":"string"}}}},"buyer":{"$ref":"#/components/schemas/Person"}}},"IssuedTicket":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orderId":{"type":"string","format":"uuid"},"ticketTypeId":{"type":"string","nullable":true},"quantity":{"type":"integer"},"checkedIn":{"type":"boolean"},"checkedInAt":{"type":"string","format":"date-time","nullable":true},"holder":{"$ref":"#/components/schemas/Person"}}},"CheckIn":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orderId":{"type":"string","nullable":true},"result":{"type":"string","enum":["ALLOW","DENY","FLAG"],"nullable":true},"reasonCode":{"type":"string","nullable":true},"scannedAt":{"type":"string","format":"date-time"}}},"WebhookEvent":{"type":"object","description":"Sent by POST to your endpoint. Header LiveArena-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the endpoint secret>.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["order.paid","order.refunded","ticket.checked_in","event.published","event.canceled"]},"created":{"type":"string","format":"date-time"},"data":{"type":"object"}}}}}}