> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fmdb.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieves the collection of Release resources.

> Retrieves the collection of Release resources.



## OpenAPI

````yaml /openapi.json get /api/releases
openapi: 3.1.0
info:
  title: FMDB API
  description: >-
    The FMDB API provides access to a comprehensive film music database,
    covering releases, productions, artists, and recordings. It is designed for
    integration with third-party applications and services. FMDB is a
    non-commercial, privacy-first platform. The API is currently in beta and
    subject to change. Authentication is required for all endpoints unless
    stated otherwise.
  version: 1.0.0 Beta
servers:
  - url: https://www.fmdb.net
    description: Production
security:
  - bearerAuth: []
tags:
  - name: ArtistGroupMember
    description: Group memberships for artists.
  - name: ArtistAlias
    description: Artist aliases including nicknames, pseudonyms, and alternate spellings.
  - name: Artist
    description: Musical artists including individuals, groups, orchestras, and choirs.
  - name: ArtistRoleResolution
    description: >-
      Resolves a free-text credit title to the best-matching artist role, scoped
      by credit context.
  - name: ArtistRole
    description: >-
      Artist roles define the function of an artist in a release, recording, or
      track.
  - name: ArtistExternalLink
    description: External links for artists (MusicBrainz, Spotify, etc.).
  - name: LabelExternalLink
    description: External links for labels (MusicBrainz, Spotify, etc.).
  - name: OrganizationExternalLink
    description: External links for organizations (VGMdb, etc.).
  - name: ProductionExternalLink
    description: External links for productions (VGMdb, MusicBrainz, etc.).
  - name: ReleaseExternalLink
    description: External links for releases (Spotify, Discogs, MusicBrainz, etc.).
  - name: Label
    description: Record labels and music publishers.
  - name: LabelSeries
    description: Label series for categorizing releases within a label.
  - name: Organization
    description: >-
      Non-performer organizations credited on recordings (orchestra contractors,
      music-preparation houses, scoring services).
  - name: PackagingType
    description: >-
      Physical packaging types for releases (Jewel Case, Digipak, Box Set,
      etc.).
  - name: ProductionEntry
    description: Individual entries (episodes, parts) within a production series.
  - name: ProductionRecording
    description: Recordings associated with a production.
  - name: Production
    description: Film, TV, and game productions with associated music.
  - name: ReleaseFormat
    description: Physical or digital formats of a release (CD, vinyl, digital).
  - name: ReleaseRecording
    description: >-
      Recordings linked to a release with effective credits after applying
      exclusions.
  - name: Release
    description: Music releases including albums, soundtracks, and compilations.
  - name: ReleaseTrack
    description: Individual tracks on a release format.
  - name: Me
    description: Resource 'Me' operations.
  - name: User
    description: Resource 'User' operations.
  - name: CollectionItem
    description: Collection items representing releases owned by a user.
  - name: WishlistItem
    description: Wishlist items representing releases a user wants to acquire.
paths:
  /api/releases:
    get:
      tags:
        - Release
      summary: Retrieves the collection of Release resources.
      description: Retrieves the collection of Release resources.
      operationId: api_releases_get_collection
      parameters:
        - name: page
          in: query
          description: The collection page number
          required: false
          deprecated: false
          schema:
            type: integer
            default: 1
          style: form
          explode: true
        - name: lifecycle_status
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
            enum:
              - announced
              - released
              - canceled
          style: form
          explode: false
        - name: lifecycle_status[]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
              enum:
                - announced
                - released
                - canceled
          style: form
          explode: true
        - name: title
          in: query
          description: Release title
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: true
        - name: title[]
          in: query
          description: Release title
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
          style: deepObject
          explode: true
        - name: country
          in: query
          description: Release country
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: true
        - name: country[]
          in: query
          description: Release country
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
          style: deepObject
          explode: true
        - name: type
          in: query
          description: Release type
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: true
        - name: production
          in: query
          description: Release production
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: true
        - name: label
          in: query
          description: Release label
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: true
        - name: barcode
          in: query
          description: Release barcode
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: true
        - name: discId
          in: query
          description: Release discId
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: true
        - name: q
          in: query
          description: Release q
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: true
        - name: order[title]
          in: query
          description: Release order[title]
          required: false
          deprecated: false
          schema:
            type: string
            enum:
              - asc
              - desc
              - ASC
              - DESC
          style: form
          explode: true
        - name: order[releasedate]
          in: query
          description: Release order[releasedate]
          required: false
          deprecated: false
          schema:
            type: string
            enum:
              - asc
              - desc
              - ASC
              - DESC
          style: form
          explode: true
        - name: order[country]
          in: query
          description: Release order[country]
          required: false
          deprecated: false
          schema:
            type: string
            enum:
              - asc
              - desc
              - ASC
              - DESC
          style: form
          explode: true
        - name: order[createdAt]
          in: query
          description: Release order[createdAt]
          required: false
          deprecated: false
          schema:
            type: string
            enum:
              - asc
              - desc
              - ASC
              - DESC
          style: form
          explode: true
      responses:
        '200':
          description: Release collection
          content:
            application/vnd.api+json:
              schema:
                description: Release.jsonapi collection.
                allOf:
                  - $ref: '#/components/schemas/JsonApiCollectionBaseSchema'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                            attributes:
                              type: object
                              properties:
                                _id:
                                  example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                                  type: string
                                title:
                                  example: The Godfather
                                  type: string
                                _type:
                                  example: album
                                  type: string
                                  enum:
                                    - album
                                    - single
                                    - ep
                                disambiguation:
                                  example: Complete Score
                                  type:
                                    - string
                                    - 'null'
                                releasedate:
                                  example: '2024-01-15'
                                  type:
                                    - string
                                    - 'null'
                                country:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                catalognumber:
                                  example: VS-5051
                                  type:
                                    - string
                                    - 'null'
                                copies:
                                  example: 5000
                                  type:
                                    - integer
                                    - 'null'
                                notes:
                                  example: Limited edition release.
                                  type:
                                    - string
                                    - 'null'
                                slug:
                                  example: the-godfather-complete-score
                                  type:
                                    - string
                                    - 'null'
                                published:
                                  example: true
                                  type: boolean
                                locked:
                                  example: false
                                  type: boolean
                                lifecycle_status:
                                  description: >-
                                    Lifecycle status of the release. Determines
                                    whether the release is expected to have
                                    complete data.
                                  default: released
                                  example: released
                                  type: string
                                  enum:
                                    - announced
                                    - released
                                    - canceled
                                created_at:
                                  example: '2024-01-15T10:00:00+00:00'
                                  type:
                                    - string
                                    - 'null'
                                  format: date-time
                                updated_at:
                                  example: '2024-01-15T14:30:00+00:00'
                                  type:
                                    - string
                                    - 'null'
                                  format: date-time
                                total_tracks:
                                  default: 0
                                  example: 12
                                  type: integer
                                total_duration:
                                  default: 0
                                  example: 3600
                                  type: integer
                                artists:
                                  example:
                                    - iri: /api/artists/a1b2c3d4
                                      id: a1b2c3d4
                                      name: Hans Zimmer
                                      name_variation: null
                                      position: 0
                                      join_phrase: ' feat. '
                                      credit_role: main
                                    - iri: /api/artists/b2c3d4e5
                                      id: b2c3d4e5
                                      name: Lisa Gerrard
                                      name_variation: null
                                      position: 1
                                      join_phrase: null
                                      credit_role: featured
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      iri:
                                        type: string
                                      id:
                                        type: string
                                      name:
                                        type: string
                                      name_variation:
                                        type:
                                          - string
                                          - 'null'
                                      position:
                                        type: integer
                                      join_phrase:
                                        type:
                                          - string
                                          - 'null'
                                      credit_role:
                                        type: string
                                        enum:
                                          - main
                                          - featured
                                artist_credit:
                                  readOnly: true
                                  description: >-
                                    The billing line derived from the artist
                                    rows above: credited names joined by their
                                    join phrases, comma-separated where no
                                    phrase is set. Read-only, and omitted when
                                    the release carries no artist rows.
                                  example: Hans Zimmer feat. Lisa Gerrard
                                  type:
                                    - string
                                    - 'null'
                                labels:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties:
                                      anyOf:
                                        - type: object
                                          additionalProperties:
                                            type: string
                                        - type: object
                                          additionalProperties:
                                            type: string
                                        - type: string
                                        - type: 'null'
                                productions:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties:
                                      anyOf:
                                        - type: integer
                                        - type: string
                                credits:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties:
                                      anyOf:
                                        - type: object
                                          additionalProperties:
                                            type: string
                                        - type: object
                                          additionalProperties:
                                            type: string
                                        - type: array
                                          items:
                                            type: object
                                            additionalProperties:
                                              type: string
                                        - type: string
                                        - type: 'null'
                                images:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties:
                                      anyOf:
                                        - type: integer
                                        - type: string
                                        - type: 'null'
                                identifiers:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties:
                                      type:
                                        - string
                                        - 'null'
                                track_labels:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties:
                                      anyOf:
                                        - type: integer
                                        - type: string
                                packaging_type:
                                  example:
                                    id: a1b2c3d4-1111-4000-8000-000000000001
                                    name: Jewel Case
                                    slug: jewel-case
                                  type:
                                    - object
                                    - 'null'
                                  additionalProperties:
                                    type: string
                                tags:
                                  example:
                                    - score
                                    - orchestral
                                  type: array
                                  items:
                                    type: string
                                recordings:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties:
                                      anyOf:
                                        - type: object
                                          additionalProperties:
                                            anyOf:
                                              - type: object
                                                additionalProperties:
                                                  anyOf:
                                                    - type: integer
                                                    - type: string
                                              - type: string
                                        - type: boolean
                                        - type: string
                                        - type: 'null'
                          required:
                            - type
                            - id
components:
  schemas:
    JsonApiCollectionBaseSchema:
      allOf:
        - $ref: '#/components/schemas/JsonApiCollectionBaseSchemaNoPagination'
        - type: object
          properties:
            links:
              type: object
              properties:
                first:
                  type: string
                  format: iri-reference
                prev:
                  type: string
                  format: iri-reference
                next:
                  type: string
                  format: iri-reference
                last:
                  type: string
                  format: iri-reference
              example:
                first: string
                prev: string
                next: string
                last: string
            meta:
              type: object
              properties:
                itemsPerPage:
                  type: integer
                  minimum: 0
                currentPage:
                  type: integer
                  minimum: 0
    JsonApiCollectionBaseSchemaNoPagination:
      type: object
      properties:
        links:
          type: object
          properties:
            self:
              type: string
              format: iri-reference
          example:
            self: string
        meta:
          type: object
          properties:
            totalItems:
              type: integer
              minimum: 0
        data:
          type: array
      required:
        - data
  securitySchemes:
    bearerAuth:
      type: http
      description: API token authentication
      scheme: bearer
      bearerFormat: JWT

````