Skip to content
Social OSU

List events

GET
/api/v1/events

Authorizations

Parameters

Query Parameters

type
string
Allowed values: EVENT GIG
category
string
startDate
string
endDate
string
source
string
Allowed values: OSU_API TICKETMASTER USER
status
string
Allowed values: OPEN IN_PROGRESS COMPLETED CANCELLED
statusMode
string
Allowed values: ACTIVE OPEN IN_PROGRESS COMPLETED CANCELLED ALL
user
string
search
string
sort
string
Allowed values: START_ASC START_DESC
limit
integer
default: 20 >= 1 <= 100
offset
integer

Responses

200

Paginated event list

object
data
required
Array<object>
object
id
required
string
title
required
string
description
required
string
summary
string
nullable
type
required
string
Allowed values: EVENT GIG
source
required
string
Allowed values: OSU_API TICKETMASTER USER
externalId
string
nullable
category
string
nullable
tags
required
Array<string>
imageUrl
string format: uri
nullable
ticketUrl
string format: uri
nullable
externalUrl
string format: uri
nullable
locationName
required
string
locationLatitude
number format: double
nullable
locationLongitude
number format: double
nullable
startAt
required
string format: date-time
endAt
string format: date-time
nullable
compensationAmount
number format: double
nullable
compensationCurrency
string
nullable
compensationType
string
Allowed values: FIXED HOURLY
status
required
string
Allowed values: OPEN IN_PROGRESS COMPLETED CANCELLED
creatorId
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
creator
object
id
required
string
displayName
required
string
nullable
email
required
string format: email
pagination
required
object
total
required
integer
limit
required
integer
offset
required
integer

400

Bad request

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string
nullable
key
additional properties
any

401

Unauthorized

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string
nullable
key
additional properties
any