Sign in

v1

latestOpenAPI 3.0.12026-07-13134151296.5 KB
AlbumApi

get/api/albums

Query parameters

querystring
discTypes'Unknown' | 'Album' | 'Single' | 'EP' | 'SplitAlbum' | 'Compilation' | 'Video' | 'Artbook' | 'Game' | 'Fanmade' | 'Instrumental' | 'Other' | 'Drama'
tagName[]string[]
tagId[]integer[]
childTagsboolean
artistId[]integer[]
artistParticipationStatus'Everything' | 'OnlyMainAlbums' | 'OnlyCollaborations'
childVoicebanksboolean
includeMembersboolean
barcodestring
status'Draft' | 'Finished' | 'Approved' | 'Locked'
releaseDateAfterstring date-time
releaseDateBeforestring date-time
filterType'Nothing' | 'ArtistType' | 'WebLink' | 'HasUserAccount' | 'RootVoicebank' | 'VoiceProvider' | 'HasStoreLink' | 'HasTracks' | 'NoCoverPicture' | 'HasAlbum' | 'HasOriginalMedia' | 'HasMedia' | 'HasMultipleVoicebanks' | 'HasPublishDate' | 'Lyrics' | 'LyricsContent'
negateboolean
paramstring nullable
startinteger
maxResultsinteger
getTotalCountboolean
sort'None' | 'Name' | 'ReleaseDate' | 'ReleaseDateWithNulls' | 'AdditionDate' | 'RatingAverage' | 'RatingTotal' | 'NameThenReleaseDate' | 'CollectionCount'
preferAccurateMatchesboolean
deletedboolean
nameMatchMode'Auto' | 'Partial' | 'StartsWith' | 'Exact' | 'Words'
fields'None' | 'AdditionalNames' | 'Artists' | 'Description' | 'Discs' | 'Identifiers' | 'MainPicture' | 'Names' | 'PVs' | 'ReleaseEvent' | 'Tags' | 'Tracks' | 'WebLinks'
lang'Default' | 'Japanese' | 'Romaji' | 'English'

Response

Success

termstring nullable
totalCountinteger