---
title: "GET /api/pvs/for-songs"
method: GET
path: "/api/pvs/for-songs"
tags: ["PVApi"]
---

# GET /api/pvs/for-songs

`GET /api/pvs/for-songs`

## Request

- Base URL: `https://vocadb.net` (the document declares no server; this is the origin it was published from)
- URL: `https://vocadb.net/api/pvs/for-songs`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vocadb/apis/vocadbweb/docs/api/pvs/for-songs/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `name` string
- `author` string
- `service` 'NicoNicoDouga' | 'Youtube' | 'SoundCloud' | 'Vimeo' | 'Piapro' | 'Bilibili' | 'File' | 'LocalFile' | 'Creofuga' | 'Bandcamp'
- `maxResults` integer
- `getTotalCount` boolean
- `lang` 'Default' | 'Japanese' | 'Romaji' | 'English'

## Response `200`

Success

- PVForSongContractPartialFindResult
  - `items` PVForSongContract[], nullable
    - `song` SongContract
      - `additionalNames` string, nullable
      - `artistString` string, nullable
      - `createDate` string, date-time
      - `deleted` boolean
      - `favoritedTimes` integer
      - `id` integer
      - `lengthSeconds` integer
      - `name` string, nullable
      - `nicoId` string, nullable
      - `publishDate` string, date-time, nullable
      - `pvServices` 'Nothing' | 'NicoNicoDouga' | 'Youtube' | 'SoundCloud' | 'Vimeo' | 'Piapro' | 'Bilibili' | 'File' | 'LocalFile' | 'Creofuga' | 'Bandcamp'
      - `ratingScore` integer
      - `songType` 'Unspecified' | 'Original' | 'Remaster' | 'Remix' | 'Cover' | 'Arrangement' | 'Instrumental' | 'Mashup' | 'MusicPV' | 'DramaPV' | 'Live' | 'Illustration' | 'Other' | 'Rearrangement' | 'ShortVersion'
      - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
      - `thumbUrl` string, nullable
      - `version` integer
    - `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
  - `term` string, nullable
  - `totalCount` integer

## Changes

- **2026-02-08** `62700309c8a8`: 3 info
  - added the optional property `items/items/description` to the response with the `200` status (media type: text/plain)
  - added the optional property `items/items/description` to the response with the `200` status (media type: application/json)
  - added the optional property `items/items/description` to the response with the `200` status (media type: text/json)
- **2024-05-28** `b15913297230`: 6 warning
  - added the new `Rearrangement` enum value to the `items/items/song/songType` response property for the response status `200` (media type: text/plain)
  - added the new `Rearrangement` enum value to the `items/items/song/songType` response property for the response status `200` (media type: application/json)
  - added the new `Rearrangement` enum value to the `items/items/song/songType` response property for the response status `200` (media type: text/json)
  - added the new `ShortVersion` enum value to the `items/items/song/songType` response property for the response status `200` (media type: text/plain)
  - …2 more

[Operation history](https://skmtc.dev/vocadb/apis/vocadbweb/changes/api/pvs/for-songs/get.md)

---

[API](https://skmtc.dev/vocadb/apis/vocadbweb.md) - [All operations](https://skmtc.dev/vocadb/apis/vocadbweb/llms.txt) - [OpenAPI document](https://skmtc.dev/vocadb/apis/vocadbweb/revisions/d1328dfaa36f?raw)