---
title: "GET /api/releaseEvents"
method: GET
path: "/api/releaseEvents"
tags: ["ReleaseEventApi"]
---

# GET /api/releaseEvents

`GET /api/releaseEvents`

## Query parameters

- `query` string
- `nameMatchMode` 'Auto' | 'Partial' | 'StartsWith' | 'Exact' | 'Words'
- `seriesId` integer
- `afterDate` string, date-time
- `beforeDate` string, date-time
- `category` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
- `userCollectionId` integer
- `tagId[]` integer[]
- `childTags` boolean
- `artistId[]` integer[]
- `childVoicebanks` boolean
- `includeMembers` boolean
- `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
- `start` integer
- `maxResults` integer
- `getTotalCount` boolean
- `sort` 'None' | 'Name' | 'Date' | 'AdditionDate' | 'SeriesName' | 'VenueName'
- `fields` 'None' | 'AdditionalNames' | 'Artists' | 'Description' | 'MainPicture' | 'Names' | 'Series' | 'SongList' | 'Tags' | 'Venue' | 'WebLinks' | 'PVs'
- `lang` 'Default' | 'Japanese' | 'Romaji' | 'English'
- `sortDirection` 'Ascending' | 'Descending'

## Response `200`

Success

- ReleaseEventForApiContractPartialFindResult
  - `items` ReleaseEventForApiContract[], nullable
    - `additionalNames` string, nullable
    - `artists` ArtistForEventContract[], nullable
      - `artist` ArtistContract
        - `additionalNames` string, nullable
        - `artistType` 'Unknown' | 'Circle' | 'Label' | 'Producer' | 'Animator' | 'Illustrator' | 'Lyricist' | 'Vocaloid' | 'UTAU' | 'CeVIO' | 'OtherVoiceSynthesizer' | 'OtherVocalist' | 'OtherGroup' | 'OtherIndividual' | 'Utaite' | 'Band' | 'Vocalist' | 'Character' | 'SynthesizerV' | 'CoverArtist' | 'NEUTRINO' | 'VoiSona' | 'NewType' | 'Voiceroid' | 'Instrumentalist' | 'Designer' | 'VOICEVOX' | 'ACEVirtualSinger' | 'AIVOICE'
        - `deleted` boolean
        - `id` integer
        - `name` string, nullable
        - `pictureMime` string, nullable
        - `releaseDate` string, date-time, nullable
        - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
        - `version` integer
      - `effectiveRoles` 'Default' | 'Dancer' | 'DJ' | 'Instrumentalist' | 'Organizer' | 'Promoter' | 'VJ' | 'Vocalist' | 'VoiceManipulator' | 'OtherPerformer' | 'Other'
      - `id` integer
      - `name` string, nullable
      - `roles` 'Default' | 'Dancer' | 'DJ' | 'Instrumentalist' | 'Organizer' | 'Promoter' | 'VJ' | 'Vocalist' | 'VoiceManipulator' | 'OtherPerformer' | 'Other'
    - `category` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
    - `date` string, date-time, nullable
    - `description` string, nullable
    - `endDate` string, date-time, nullable
    - `id` integer
    - `mainPicture` EntryThumbForApiContract
      - `mime` string, nullable
      - `name` string, nullable
      - `urlOriginal` string, nullable
      - `urlSmallThumb` string, nullable
      - `urlThumb` string, nullable
      - `urlTinyThumb` string, nullable
    - `name` string, nullable
    - `names` LocalizedStringContract[], nullable
      - `language` 'Unspecified' | 'Japanese' | 'Romaji' | 'English'
      - `value` string, nullable
    - `pvs` PVContract[], nullable
      - `author` string, nullable
      - `createdBy` integer, nullable
      - `description` string, nullable
      - `disabled` boolean
      - `extendedMetadata` PVExtendedMetadata
        - `json` string, nullable
      - `id` integer
      - `length` integer
      - `name` string, nullable
      - `publishDate` string, date-time, nullable
      - `pvId` string, nullable
      - `service` 'NicoNicoDouga' | 'Youtube' | 'SoundCloud' | 'Vimeo' | 'Piapro' | 'Bilibili' | 'File' | 'LocalFile' | 'Creofuga' | 'Bandcamp'
      - `pvType` 'Original' | 'Reprint' | 'Other'
      - `thumbUrl` string, nullable
      - `url` string, nullable
    - `series` ReleaseEventSeriesContract
      - `additionalNames` string, nullable
      - `category` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
      - `deleted` boolean
      - `description` string, nullable
      - `id` integer
      - `name` string, nullable
      - `pictureMime` string, nullable
      - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
      - `urlSlug` string, nullable
      - `version` integer
      - `webLinks` WebLinkContract[], nullable
        - `category` 'Official' | 'Commercial' | 'Reference' | 'Other'
        - `description` string, nullable
        - `descriptionOrUrl` string, nullable
        - `disabled` boolean
        - `id` integer
        - `url` string, nullable
    - `seriesId` integer, nullable
    - `seriesNumber` integer
    - `seriesSuffix` string, nullable
    - `songList` SongListBaseContract
      - `featuredCategory` 'Nothing' | 'Concerts' | 'VocaloidRanking' | 'Pools' | 'Other'
      - `id` integer
      - `name` string, nullable
    - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
    - `tags` TagUsageForApiContract[], nullable
      - `count` integer
      - `tag` TagBaseContract
        - `additionalNames` string, nullable
        - `categoryName` string, nullable
        - `id` integer
        - `name` string, nullable
        - `urlSlug` string, nullable
    - `urlSlug` string, nullable
    - `venue` VenueForApiContract
      - `additionalNames` string, nullable
      - `address` string, nullable
      - `addressCountryCode` string, nullable
      - `coordinates` OptionalGeoPointContract
        - `formatted` string, nullable
        - `hasValue` boolean
        - `latitude` number, double, nullable
        - `longitude` number, double, nullable
      - `deleted` boolean
      - `description` string, nullable
      - `events` ReleaseEventContract[], nullable
        - `additionalNames` string, nullable
        - `category` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
        - `customName` boolean
        - `date` string, date-time, nullable
        - `deleted` boolean
        - `description` string, nullable
        - `endDate` string, date-time, nullable
        - `hasVenueOrVenueName` boolean
        - `id` integer
        - `inheritedCategory` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
        - `name` string, nullable
        - `pictureMime` string, nullable
        - `series` ReleaseEventSeriesContract
          - `additionalNames` string, nullable
          - `category` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
          - `deleted` boolean
          - `description` string, nullable
          - `id` integer
          - `name` string, nullable
          - `pictureMime` string, nullable
          - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
          - `urlSlug` string, nullable
          - `version` integer
          - `webLinks` WebLinkContract[], nullable
            - `category` 'Official' | 'Commercial' | 'Reference' | 'Other'
            - `description` string, nullable
            - `descriptionOrUrl` string, nullable
            - `disabled` boolean
            - `id` integer
            - `url` string, nullable
        - `songList` SongListBaseContract
          - `featuredCategory` 'Nothing' | 'Concerts' | 'VocaloidRanking' | 'Pools' | 'Other'
          - `id` integer
          - `name` string, nullable
        - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
        - `urlSlug` string, nullable
        - `venue` VenueContract
          - `additionalNames` string, nullable
          - `address` string, nullable
          - `addressCountryCode` string, nullable
          - `coordinates` OptionalGeoPointContract
            - `formatted` string, nullable
            - `hasValue` boolean
            - `latitude` number, double, nullable
            - `longitude` number, double, nullable
          - `deleted` boolean
          - `description` string, nullable
          - `id` integer
          - `name` string, nullable
          - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
          - `version` integer
          - `webLinks` WebLinkContract[], nullable
            - `category` 'Official' | 'Commercial' | 'Reference' | 'Other'
            - `description` string, nullable
            - `descriptionOrUrl` string, nullable
            - `disabled` boolean
            - `id` integer
            - `url` string, nullable
        - `venueName` string, nullable
        - `version` integer
      - `id` integer
      - `name` string, nullable
      - `names` LocalizedStringContract[], nullable
        - `language` 'Unspecified' | 'Japanese' | 'Romaji' | 'English'
        - `value` string, nullable
      - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
      - `version` integer
      - `webLinks` WebLinkForApiContract[], nullable
        - `category` 'Official' | 'Commercial' | 'Reference' | 'Other'
        - `description` string, nullable
        - `descriptionOrUrl` string, nullable
        - `disabled` boolean
        - `id` integer
        - `url` string, nullable
    - `venueName` string, nullable
    - `version` integer
    - `webLinks` WebLinkForApiContract[], nullable
      - `category` 'Official' | 'Commercial' | 'Reference' | 'Other'
      - `description` string, nullable
      - `descriptionOrUrl` string, nullable
      - `disabled` boolean
      - `id` integer
      - `url` string, nullable
  - `term` string, nullable
  - `totalCount` integer

---

[API](https://skmtc.net/vocadb/apis/vocadbweb.md) · [All operations](https://skmtc.net/vocadb/apis/vocadbweb/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vocadb/vocadbweb/versions/d1328dfaa36f/schema)