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

List workspace events

Minimum role: VIEWER. Active workspace via the X-Workspace-Id header. Each event embeds nextDate (its next upcoming date, or null) and artists (the linked lineup, in the organizer’s order), so rendering a catalog doesn’t require /events/{id}/dates or one request per artist.

GET/events
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
limitinteger

1-100, default 20

default: 20
cursorstring

id of the last result from the previous page

qstring

Search by name/description, case- and accent-insensitive

statusstring

Filter by status (DRAFT | PUBLISHED | SOLD_OUT | CANCELLED | COMPLETED). Applied in the query, so limit only counts returned rows.

Allowed:DRAFTPUBLISHEDSOLD_OUTCANCELLEDCOMPLETED
withTotalboolean

1 to include page.total (count over the same filter). Opt-in: without it, the extra query is skipped.

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

dataEvent[]required
Show properties
Array of Event
idstringrequired
namestringrequired
slugstringrequired
descriptionstring | nullrequired
Show properties
Any of:
string
string
null
null
statusstringrequired
Allowed:DRAFTPUBLISHEDSOLD_OUTCANCELLEDCOMPLETED
coverImageUrlstring | nullrequired
Show properties
Any of:
string
string
null
null
bannerImageUrlstring | nullrequired
Show properties
Any of:
string
string
null
null
squareImageUrlstring | nullrequired
Show properties
Any of:
string
string
null
null
storyImageUrlstring | nullrequired
Show properties
Any of:
string
string
null
null
organizationIdstringrequired
venueIdstring | nullrequired
Show properties
Any of:
string
string
null
null
venueVenue | nullrequired
Show properties
Any of:
Venue
idstringrequired
namestringrequired
slugstringrequired
addressstringrequired
citystringrequired
countrystringrequired
latitudenumber | nullrequired
Show properties
Any of:
number
number
null
null
longitudenumber | nullrequired
Show properties
Any of:
number
number
null
null
capacityinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
googlePlaceIdstring | nullrequired
Show properties
Any of:
string
string
null
null
portalVisiblebooleanrequired
organizationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
seatsioChartKeystring | nullrequired
Show properties
Any of:
string
string
null
null
createdAtstringrequired
null
null
externalTicketUrlstring | nullrequired
Show properties
Any of:
string
string
null
null
accessstringrequired

owner = the key's workspace owns the event (editable). artist = read-only: linked artist or catalog access.

Allowed:ownerartist
nextDateEventNextDate | null
Show properties
Any of:
EventNextDate
idstringrequired
labelstring | nullrequired
Show properties
Any of:
string
string
null
null
startsAtstringrequired
endsAtstring | nullrequired
Show properties
Any of:
string
string
null
null
timezonestringrequired
statusstringrequired
Allowed:DRAFTPUBLISHEDSOLD_OUTCANCELLEDCOMPLETED
null
null
artistsEventArtist[]
Show properties
Array of EventArtist
idstringrequired
namestringrequired
slugstring | nullrequired
Show properties
Any of:
string
string
null
null
typestringrequired
Allowed:ARTISTVENUEORGANIZER
createdAtstringrequired
updatedAtstringrequired
pagePagerequired
Show properties
nextCursorstring | nullrequired
Show properties
Any of:
string
string
null
null
hasMorebooleanrequired
totalinteger
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/events' \
  -H 'Authorization: YOUR_API_KEY'
Response
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "status": "DRAFT",
      "coverImageUrl": "string",
      "bannerImageUrl": "string",
      "squareImageUrl": "string",
      "storyImageUrl": "string",
      "organizationId": "string",
      "venueId": "string",
      "venue": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "address": "string",
        "city": "string",
        "country": "string",
        "latitude": 0,
        "longitude": 0,
        "capacity": -9007199254740991,
        "googlePlaceId": "string",
        "portalVisible": true,
        "organizationId": "string",
        "seatsioChartKey": "string",
        "createdAt": "string"
      },
      "externalTicketUrl": "string",
      "access": "owner",
      "nextDate": {
        "id": "string",
        "label": "string",
        "startsAt": "string",
        "endsAt": "string",
        "timezone": "string",
        "status": "DRAFT"
      },
      "artists": [
        {
          "id": "string",
          "name": "string",
          "slug": "string",
          "type": "ARTIST"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "page": {
    "nextCursor": "string",
    "hasMore": true,
    "total": -9007199254740991
  },
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "field": "string",
      "activeWorkspaceId": "string",
      "activeWorkspaceName": "string",
      "accessibleWorkspaces": -9007199254740991,
      "suggestedWorkspaceId": "string",
      "suggestedWorkspaceName": "string"
    }
  ]
}