Skip to content
FreeTicketDocs
Esc
↑↓navigate↵open⌘Jpreview

Inventory aggregated by event/date/ticket type (capacity, sold, available)

Minimum role: VIEWER. Active workspace via the X-Workspace-Id header.

GET/reports/inventory
Authorization
AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

or
x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Query parameters
eventIdstring

Filter by event

eventDateIdstring

Filter by event date

fromstring

Event date start ≥ (ISO 8601)

tostring

Event date start ≤ (ISO 8601)

includeDraftsboolean

Include DRAFT events/dates (default false)

default: false
groupBystring

event | date | ticketType (default)

default: "ticketType"
Allowed:eventdateticketType
Header parameters
X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses
200

OK

dataInventoryRow[]required
Show properties
Array of InventoryRow
eventIdstringrequired
eventNamestringrequired
eventStatusstringrequired
Allowed:DRAFTPUBLISHEDSOLD_OUTCANCELLEDCOMPLETED
eventDateIdstring | nullrequired
Show properties
Any of:
string
string
null
null
startsAtstring | nullrequired
Show properties
Any of:
string
string
null
null
ticketTypeIdstring | nullrequired
Show properties
Any of:
string
string
null
null
ticketTypeNamestring | nullrequired
Show properties
Any of:
string
string
null
null
capacityintegerrequired
min -9007199254740991 · max 9007199254740991
soldintegerrequired
min -9007199254740991 · max 9007199254740991
reservedintegerrequired
min -9007199254740991 · max 9007199254740991
availableintegerrequired
min -9007199254740991 · max 9007199254740991
warningsWarning[]
Show properties
Array of Warning
codestringrequired
messagestringrequired
fieldstring
activeWorkspaceIdstring
activeWorkspaceNamestring
accessibleWorkspacesinteger
min -9007199254740991 · max 9007199254740991
suggestedWorkspaceIdstring
suggestedWorkspaceNamestring
401

Missing or invalid credential.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
403

Insufficient role or resource not accessible.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
404

Resource does not exist or is out of scope.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
422

Request body/parameter validation failed.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsany
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://admin.appfreeticket.com/api/v1/reports/inventory' \
  -H 'Authorization: YOUR_API_KEY'
Response
{
  "data": [
    {
      "eventId": "string",
      "eventName": "string",
      "eventStatus": "DRAFT",
      "eventDateId": "string",
      "startsAt": "string",
      "ticketTypeId": "string",
      "ticketTypeName": "string",
      "capacity": -9007199254740991,
      "sold": -9007199254740991,
      "reserved": -9007199254740991,
      "available": -9007199254740991
    }
  ],
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "field": "string",
      "activeWorkspaceId": "string",
      "activeWorkspaceName": "string",
      "accessibleWorkspaces": -9007199254740991,
      "suggestedWorkspaceId": "string",
      "suggestedWorkspaceName": "string"
    }
  ]
}