Skip to content
Social OSU

Get a collection visible to the caller

GET
/api/v1/collections/{collectionId}

Authorizations

Parameters

Path Parameters

collectionId
required
string

Responses

200

Collection with collection items and expanded events

object
id
required
string
userId
required
string
name
required
string
visibility
required
string
Allowed values: PRIVATE PUBLIC
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
items
required
Array
object
id
required
string
collectionId
required
string
eventId
required
string
createdAt
required
string format: date-time
event
required
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

401

Unauthorized

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

404

Resource not found

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