Music API

The OpenPlay Music API allows you to manage your catalog data over a simple JSON REST API.

Version 2

The legacy OpenPlay Connect API (Version 1) is still available, but you'll need to upgrade to this version to use all the new functionality.

The OpenPlay Music API has different features for every account. You are viewing the public documentation. This covers most of what the API can do, but the documentation for your account may include different features and additional details. Sign in to view the most accurate docs.

Quick Start Anchor link icon

  1. Request an API Key from an account administrator and store the API Secret Key somewhere safe (like a password manager)
  2. Use curl to make a request to the API, including your API Key ID as the basic authentication username with -u
  3. When prompted for your password enter the API Secret Key

Request API version

curl https://{subdomain}.openplaymusic.com/connect/v2/ \ -u {API Key Id}

General Considerations Anchor link icon

These apply to all parts of the OpenPlay Music API.

JSON API Anchor link icon

The OpenPlay Music API uses JSON exclusively. All requests return JSON responses. Requests that require a request body expect it to be in JSON format.

There are JSON libraries available for all popular, and many unpopular, programming languages.

Versioning Anchor link icon

Breaking changes will not be introduced without changing the API version.

New features and data will be added to the current API version without incrementing the version.

Backwards-incompatible changes, such as changing or removing features or data, will be released with a new version of the API.

Backwards-incompatible changes may occasionally be required to avoid security issues.

Previous API versions will be deprecated and removed over time.

Rate Limiting Anchor link icon

To ensure fair use and maintain system stability, we enforce rate limits on all API requests.

When You Hit the Limit

If you exceed the allowed number of requests, the API will respond with a 429 Too Many Requests status code.

The response will also include a Retry-After header indicating how many seconds you should wait before making another request.

Best Practices

  • Implement backoff and retry logic using the Retry-After value.
  • Space out your requests to stay within the allowed limits.

Response example

HTTP/1.1 429 Too Many Requests Retry-After: 5 Content-Type: application/json { "error": "Rate limit exceeded; retry after 5 seconds" }

Concurrency Anchor link icon

Concurrent Key Creation

The API prevents concurrent creation of some record keys in order to avoid race conditions with "find or create" behavior. When multiple record creation attempts, with the same protected key, happen at the same time, the API will respond with a 409 Conflict status code. See the response example for more.

Depending on how you want to handle duplicate records you may want to then check for an existing record rather than retry the request. Requests that respond with a 409 Conflict can be retried and will succeed as long as there is not another concurrent conflicting request.

As an example: say two systems are syncing track records to OpenPlay Music via this API. If those two systems want to avoid creating duplicate track records they can use a "find or create" strategy to first find a track by isrc, and only create a new track if the track does not already exist. If both systems attempt to "find or create" the track at the same they will be subject to a race condition where neither system finds the track so both attempt to create it. The API will then prevent concurrent creation of two tracks with the same isrc. One system will succeed, and the other system will get a 409 Conflict response. The system that failed can then retry the "find or create" operation, which will now find the existing track and avoid creating a duplicate record.

The API prevents concurrent creation of the following keys:

Record Protected Record Key
Tracks isrc
Artists name
Publishers name
Labels name
Projects project_number

This can also happen with concurrent creation of nested records. For instance the API uses "find or create" behavior when automatically adding new artist records on contributions. If concurrent requests are sending contributions with the same artist they may conflict rather than create duplicate artist records. When that happens they will respond with a 409 Conflict status code and can be retried, which will then use the existing artist records.

Response example

HTTP/1.1 409 Conflict Content-Type: application/json { error: "Concurrent record key creation prevented. Retry to add a duplicate record key. See documentation for more details about Concurrency." }

Idempotency Anchor link icon

Idempotent Requests

The API supports idempotency for safely retrying record creation requests without accidentally creating the same record twice. To make a request idempotent, send a unique value in an Idempotency-Key header. Idempotency is only available on record creation (POST) requests.

The API stores the Idempotency-Key with the record it creates. If the same key is sent again the API returns the response of the original record, as if it were just created, rather than creating a second record. This means a request that times out or fails to return can be safely retried with the same key.

When the API returns an existing record instead of creating a new one it includes an Idempotency-Replayed: true response header. The status code and body are otherwise identical to a normal create.

An Idempotency-Key is unique per API key and record type.

If an Idempotency-Key is reused with different parameters the API responds with a 409 Conflict status code.

We recommend generating a unique Idempotency-Key for each create request, such as a version 4 UUID. A key must be a non-empty string of at most 255 characters. Remember to reuse the key on retry and not generate a new one.

Automatic Duplicate Detection

Requests that do not send an Idempotency-Key are still protected from accidental duplicates. The API will detect multiple requests from the same API key with the same parameters and avoid creating duplicate records, responding the same way a repeated Idempotency-Key does, instead of creating a duplicate.

Two requests with the same parameters but different Idempotency-Key headers will be considered different requests, and can create duplicate records.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -H "Idempotency-Key: 1f1ab2c3-4d5e-6f70-8a9b-0c1d2e3f4a5b" \ -d@./record.json

Replayed response example

HTTP/1.1 200 OK Idempotency-Replayed: true Content-Type: application/json { id: 5000001, name: "Michael McDonald" }

Conflict response example

HTTP/1.1 409 Conflict Content-Type: application/json { error: "Idempotency-Key conflict. This Idempotency-Key was already used with a different request." }

API Keys & Authentication Anchor link icon

The OpenPlay Music API uses Basic Authentication over HTTPS to authenticate access. You will need an API Key which consists of an API Key ID and API Secret Key in order to authenticate.

Generating an API Key Anchor link icon

API Key management can be found under Manage iconAPI Keys in either OpenPlay Music or OpenPlay Platform.

To generate a new API Key click the New button. After clicking New you will be able to enter a description of the new API Key. Upon clicking Save Changes the new API Key will be generated and you will be shown the API Key ID and API Secret Key.

Important This is the only time you will be able to see the API Secret Key. For security it is not retrievable. Treat it as a password and store it somewhere safe such as a password manager.

If you lose your API Secret Key you can generate a new API Key at any time. You should also revoke your old API Key if it is no longer in use so that it cannot be used to access your data. It is a good practice to rotate your API Keys on a regular basis to prevent the spread of an unknowingly leaked key.

The DESCRIPTION field is only for reference and can be changed at any time without affecting the operation of the API Key.

Authenticating with an API Key Anchor link icon

All requests to the API are authenticated using Basic Authentication over HTTPS.

Basic Authentication is convenient but comes with some security considerations to be aware of:

Because many HTTP/S clients allow embedding Basic Authentication credentials in the URL they may end up appearing in logs if your code is logging requests before they go out. This can then be a security risk if someone has, or gets access to, those logs. It is best to never embed your credentials in the URL to avoid them appearing in any intermediary logs.

Your credentials are secured over HTTPS so once the request is made they cannot be intercepted. The API does not log the API Secret Key used to make incoming requests.

Basic Authentication headers are sent base64 encoded. Base64 encoding is trivially reversible so treat the authentication header just like your API Secret Key in plain text. Be cautious when logging or exposing your request headers.

Revoking an API Key Anchor link icon

Revoking an API Key will disallow the API Key from being used to access the OpenPlay Music API. You can revoke an API Key and generate a new one at any time. It is a good practice to periodically revoke and generate new API Keys for all of your integrations.

Click the Revoke button on any API Key to revoke the API Key. You will be prompted to confirm the action. Upon confirmation the API Key will be immediately unusable.

Revocation cannot be reversed. You will instead need to generate a new API Key and update the credentials used for any integrations.

Request example with basic authentication

curl https://{subdomain}.openplaymusic.com/connect/v2/ \ -u {API Key Id}

Webhooks Anchor link icon

Webhooks allow you to be notified automatically when specific events occur.

Webhooks work by sending an HTTP POST request to your server every time a specific event happens. This allows you keep external systems up to date without having to poll the OpenPlay Music API.

You might use Webhooks for everything from sending a custom email whenever a new Artist is added to updating an external finance system every time a Release is distributed.

Receiving Webhooks Anchor link icon

Webhooks send an HTTP POST request from OpenPlay to your server. In order to receive the request you will need to be running a server, accessible from the internet, configured to handle the request.

Webhooks will allow non-secure HTTP requests when testing, however active Webhooks must be sent over a secure HTTPS connection with a valid SSL certificate.

To get started developing a server endpoint you can use a free tool like Ngrok to expose a server running on your computer to the internet.

Your server needs to be configured to handle an HTTP POST request at a URL of your choosing. You will then configure the webhook to POST to whatever URL you have configured in your server.

Like the API the Webhooks use JSON exclusively. The webhook will send the POST request with an example JSON body:

{ id: 93813, mode: "live", event: { source: "OpenPlay Music" name: "release_distributed", id: 498183 } }

The id in the webhook body is the ID of the related Release, and the GET a Release endpoint can then be queried using that ID to get additional Release details.

Upon receiving the webhook your server should respond with a status code in the 200 range. We will consider any 2xx status code to be a success.

Timeout Your server must respond with a 2xx status code within a few seconds. If your server takes too long OpenPlay will consider the request timed out. A consistent pattern of timeouts may lead to your Webhook being automatically disabled. Ensure a fast response by delaying heavy processing until after responding.

OpenPlay will not automatically retry failed webhook requests.

Configuring Webhooks Anchor link icon

Webhooks can be configured under Manage iconWebhooks.

Click the New button to add a new Webhook.

The NAME field is only used to help differentiate Webhooks in the list. You can use any name you like and can change it at any time without affecting the operation of the webhook.

Set the URL to the full URL of your server and configured request path, for instance (using ngrok):

http://9baa79f.ngrok.io/webhook

Inactive webhooks will allow sending to HTTP URLs. When your webhook is ready to go live you can switch the webhook to Active. Active webhooks require sending to a HTTPS URL with a valid SSL certificate.

You can test that your Active webhook is working by switching to Active mode and sending a test request. The webhook will only start sending once your changes are saved.

You can switch a webhook between Active and Inactive at any time. Your webhook will only send requests while it is active.

Testing Webhooks Anchor link icon

You can test your webhooks from the same place you configure them. When viewing a Webhook you will see a TESTING section below the webhook details.

To send a test enter the ID of any Release in OpenPlay and click Send Test Request. OpenPlay will send a test request to the Webhook's URL with the same data as a live Webhook request.

Test webhook requests are sent with mode: "test" in the body, while active webhook requests have mode: "live".

Request and response details will appear in the UI after sending the test to aid in verifying and debugging your Webhook configuration.

Securing Webhooks Anchor link icon

Each Webhook is created with a Secret Token. The Secret Token is used to HMAC sign each Webhook request sent from OpenPlay. The request from OpenPlay will have an Authorization-Signature header that can then be used, with the Secret Token, to verify that the request came from OpenPlay and that the request body was not tampered with.

Important As the name implies the Secret Token is meant to be kept secret. It will be used by the receiver to validate the incoming message but is never sent in a request itself. Anyone with access to the Secret Token could potentially sign requests for that Webhook as if they had come from OpenPlay. In the event your Secret Token may be compromised the simplest thing to do is to configure a new Webhook, which will have a new Secret Token, and disable the compromised one.

Webhook requests sent from OpenPlay have an HTTP request header: Authorization-Signature. This is the SHA-256 HMAC hex digest generated from the Secret Token and the request body.

After receiving the request you can verify the request is from OpenPlay, and unmodified, by calculating the signature on your side from the same Secret Token and the received request body. If the signature you calculated matches the signature sent in the Authorization-Signature HTTP header then you can verify that it was sent from OpenPlay and has not been modified.

To calculate the signature on your side you will need to use the exact same algorithm and components as the signature was generated with. This includes formatting (like whitespace) so be careful not to pre-process the request body before verifying it. There are HMAC and SHA-256 digest algorithms for pretty much every programming language -- an example in a Ruby webserver might look like:

request.body.rewind body = request.body.read signature = "sha256=" + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha256"), ENV["SECRET_TOKEN"], body) halt 401 if !Rack::Utils.secure_compare(signature, request.headers[:"Authorization-Signature"])

Important Many programming languages have a constant-time string comparison method available like secure_compare in Ruby above. Using a constant-time comparison (instead of the something like ==) can help reduce the risk of leaking information from your server via timing attacks.

Webhook Logging Anchor link icon

You can see previous webhook requests and their statuses in the table of PAST REQUESTS AND RESPONSES when viewing a webhook.

Webhook Errors Anchor link icon

Webhooks will not be automatically retried if they are unable to send.

API V2 Reference Anchor link icon

While we are actively expanding our API, the following expansive list of OpenPlay Music API endpoints is available today:

Releases Anchor link icon

Also known as Albums, Releases represent a music product. A Release might have multiple discs, or may even be a package of multiple Releases itself, but ultimately represents some collection of music packaged and sold together.

The Release Object Anchor link icon

Attributes

  • title string
  • configuration string

    The main release type. Different release configurations have different features and validations (for instance audio vs video configurations).

  • label string
  • display_title string or null
  • version_title string or null

    Used to distinguish multiple versions of the same record. (Example: 'Live')

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • series_name string or null

    Name of the Series (Example: 'Greatest Hits Collection')

  • release_date date

    Primary release date associated with the Release

  • release_time time
  • original_release_date date

    The date this Release was originally released if previously released.

  • artist_display_name string or null
  • artist_type string or null
  • name_format string or null
  • upc string or null

    UPC (US 12-digit code with optional leading zeros) or EAN (Europe 13-digit code with optional leading zero)

  • catalog_number string or null

    A local release number or catalog number used internally to uniquely identify the release

  • music_type string or null

    Type of Music (May impact available metadata fields)

  • audio_language string or null

    Primary language of recorded audio

  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • compilation_type string or null

    Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

  • cover_art_id integer or null

    ID of associated Cover Art record. Use to associate a Cover Art record with a Release. Search Art Resources to find Cover Art records.

  • parental_advisory string or null
  • promotional boolean

    If checked, this Release is a promotion (non-commercial) release

  • box_set boolean

    If checked, this Release is part of a box set

  • indie_exclusive boolean

    If checked, this Release is an Indie Exclusive

  • soundtrack boolean

    If checked, this Release contains audio used for the soundtrack of a Film or Television show

  • audio_presentation string or null

    The format of the associated audio

  • resolution_type string or null

    The type of HD content. Digital configurations only.

  • studio string or null

    Studio Name for MFiT Releases. Digital configurations only.

  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • internal_synopsis string or null

    Summary information meant for internal use. This data is not passed to downstream systems or partners.

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • distribution_group string or null
  • territory_rights array of territory_rights objects
    • territory_rights.region_id integer
    • territory_rights.legal boolean
    • territory_rights.release_date date

      The primary release date associated with this Release

    • territory_rights.preorder_date date

      Date at which the release becomes available for Pre-Order

    • territory_rights.distribution_territory boolean
    • territory_rights.default_track_territory_rights default_track_territory_rights object
      • territory_rights.default_track_territory_rights.legal boolean
      • territory_rights.default_track_territory_rights.prestream_date date

        The date this track becomes available to Pre-Stream

      • territory_rights.default_track_territory_rights.instant_grat_date date

        The date this track becomes available for Instant Grat

      • territory_rights.default_track_territory_rights.sellable boolean

        If this Track can be sold separately

      • territory_rights.default_track_territory_rights.download boolean

        If this Track has Permanent Download rights

      • territory_rights.default_track_territory_rights.streaming boolean

        If this Track has Subscription streaming rights

      • territory_rights.default_track_territory_rights.ad_supported_streaming boolean

        If this Track has Ad Supported streaming rights

      • territory_rights.default_track_territory_rights.user_generated_video string or null

        User Generated Video rights

  • rights_period string or null
  • rights_expiry_rule string or null
  • lost_rights boolean

    e.g. "The license has expired and you've lost the right to distribute this release"

  • lost_rights_on date
  • lost_rights_reason string or null
  • partner_restrictions string or null
  • distribution_notes string or null
  • license string or null
  • license_start date
  • license_expiration date
  • track_listing_embargo date
  • audio_embargo date
  • cover_art_embargo date
  • product_details_embargo date
  • project_id integer or null
  • partners partners object
    • partners.excluded boolean
    • partners.partner_names array of strings
  • release_price_tier string or null
  • track_price_tier string or null

    Digital configurations only.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • cover_art cover_art object
    • cover_art.title string or null
    • cover_art.resource_number string or null
    • cover_art.parental_advisory string or null

      A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.artist_display_name string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.internal_synopsis string or null

      Summary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.series string or null
    • translations.title string or null
    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.video_long_description string or null
    • translations.video_network string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_rating_reason string or null
    • translations.video_short_description string or null
  • discs array of discs objects

    Discs associate tracks (via disc_tracks) to releases. A release may have 1 or more discs, and those discs may have 1 or more tracks (via disc_tracks).

    • discs.id integer or null

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • discs.number integer or null
    • discs.upc string or null

      Individual discs on multi-disc releases may sometimes have separate UPCs. They may be internal tracking UPCs rather than registered product UPCs.

    • discs.disc_tracks array of disc_tracks objects

      disc_tracks associate tracks to release via discs (hence the name disc_tracks). They also hold information about the track-on-the-release such as the track number, whether the track is a hidden track, various rights details, etc...

      • discs.disc_tracks.id integer or null

        Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

      • discs.disc_tracks.number integer or null
      • discs.disc_tracks.side integer or string or null

        The side this track belongs to (for double-sided release configurations). Can be any of A, B, 1, or 2.

      • discs.disc_tracks.track_id integer
      • discs.disc_tracks.global_instant_grat_date date
      • discs.disc_tracks.global_prestream_date date
      • discs.disc_tracks.territory_rights array of territory_rights objects
        • discs.disc_tracks.territory_rights.region_id integer or null
        • discs.disc_tracks.territory_rights.legal boolean
        • discs.disc_tracks.territory_rights.prestream_date date

          The date this track becomes available to Pre-Stream

        • discs.disc_tracks.territory_rights.instant_grat_date date

          The date this track becomes available for Instant Grat

        • discs.disc_tracks.territory_rights.sellable boolean

          If this Track can be sold separately

        • discs.disc_tracks.territory_rights.download boolean

          If this Track has Permanent Download rights

        • discs.disc_tracks.territory_rights.streaming boolean

          If this Track has Subscription streaming rights

        • discs.disc_tracks.territory_rights.ad_supported_streaming boolean

          If this Track has Ad Supported streaming rights

        • discs.disc_tracks.territory_rights.user_generated_video string or null

          User Generated Video rights

      • discs.disc_tracks.track Track object
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • number integer

    (Package releases only)

    When a release is a component of a package release this field denotes the component sequence order

  • components array of Release objects

    (Package releases only)

    Components associate releases with a bundle/package release. Existing releases can be added to a Bundle as components using the release_id parameter or new releases can be created using the release parameter.

The Release Object

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null, "number": "MP-54321-1" }, "number": "P-12345-1" }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] }

Search Releases Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/releases/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[title] string

    Title to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • filters[upc] string

    UPC to filter by

  • filters[project_number] string

    Project Number to filter by

  • filters[label][] string

    Pass an array of Label names to filter Releases by their associated Label

  • filters[keywords][] string

    Pass an array of Keywords to filter by

  • filters[track_id][] integer

    Pass an array of Track IDs to filter Releases by their associated Tracks

  • filters[work_id][] integer

    Pass an array of Work IDs to filter Releases by their associated Works

  • filters[resource_id][] integer

    Pass an array of Art Resource or Cover Art IDs to filter Releases by their associated Art Resources

  • filters[artist_id][] integer

    Pass an array of Artist IDs to filter by

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.title string
    • results.upc string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/ \ -u {API Key Id} \ -G \ -d "q=If+Thats+What+It+Takes" \ -d "filters[upc]=555555555555" \ -d "filters[label][]=Awesome+Records" \ -d "filters[label][]=Smooth+Records"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/releases/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/releases/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000023, "title": "If That's What It Takes", "upc": "555555555555" } ] }

Create a Release Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/releases/

The schema for creating a Release optionally also includes most of the records that can be created along with a Release (Tracks, Works, Art Resources, etc...). The Create a Release API can then be used both to create new Releases that will be added to over time or via additional API requests, or to import a full Release representation, including all related metadata, in a single request (often used for importing Releases).

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • title string
  • configuration string

    The main release type. Different release configurations have different features and validations (for instance audio vs video configurations).

  • label string
  • display_title string or null
  • version_title string or null

    Used to distinguish multiple versions of the same record. (Example: 'Live')

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • series_name string or null

    Name of the Series (Example: 'Greatest Hits Collection')

  • release_date date

    Primary release date associated with the Release

  • release_time time
  • original_release_date date

    The date this Release was originally released if previously released.

  • artist_display_name string or null
  • artist_type string or null
  • name_format string or null
  • upc string or null

    UPC (US 12-digit code with optional leading zeros) or EAN (Europe 13-digit code with optional leading zero)

  • catalog_number string or null

    A local release number or catalog number used internally to uniquely identify the release

  • music_type string or null

    Type of Music (May impact available metadata fields)

  • audio_language string or null

    Primary language of recorded audio

  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • compilation_type string or null

    Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

  • cover_art_id integer or null

    ID of associated Cover Art record. Use to associate a Cover Art record with a Release. Search Art Resources to find Cover Art records.

  • parental_advisory string or null
  • promotional boolean

    If checked, this Release is a promotion (non-commercial) release

  • box_set boolean

    If checked, this Release is part of a box set

  • indie_exclusive boolean

    If checked, this Release is an Indie Exclusive

  • soundtrack boolean

    If checked, this Release contains audio used for the soundtrack of a Film or Television show

  • audio_presentation string or null

    The format of the associated audio

  • resolution_type string or null

    The type of HD content. Digital configurations only.

  • studio string or null

    Studio Name for MFiT Releases. Digital configurations only.

  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • internal_synopsis string or null

    Summary information meant for internal use. This data is not passed to downstream systems or partners.

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • distribution_group string or null
  • territory_rights array of territory_rights objects
    • territory_rights.region_id integer
    • territory_rights.legal boolean
    • territory_rights.release_date date

      The primary release date associated with this Release

    • territory_rights.preorder_date date

      Date at which the release becomes available for Pre-Order

    • territory_rights.distribution_territory boolean
    • territory_rights.default_track_territory_rights default_track_territory_rights object
      • territory_rights.default_track_territory_rights.legal boolean
      • territory_rights.default_track_territory_rights.prestream_date date

        The date this track becomes available to Pre-Stream

      • territory_rights.default_track_territory_rights.instant_grat_date date

        The date this track becomes available for Instant Grat

      • territory_rights.default_track_territory_rights.sellable boolean

        If this Track can be sold separately

      • territory_rights.default_track_territory_rights.download boolean

        If this Track has Permanent Download rights

      • territory_rights.default_track_territory_rights.streaming boolean

        If this Track has Subscription streaming rights

      • territory_rights.default_track_territory_rights.ad_supported_streaming boolean

        If this Track has Ad Supported streaming rights

      • territory_rights.default_track_territory_rights.user_generated_video string or null

        User Generated Video rights

  • rights_period string or null
  • rights_expiry_rule string or null
  • lost_rights boolean

    e.g. "The license has expired and you've lost the right to distribute this release"

  • lost_rights_on date
  • lost_rights_reason string or null
  • partner_restrictions string or null
  • distribution_notes string or null
  • license string or null
  • license_start date
  • license_expiration date
  • track_listing_embargo date
  • audio_embargo date
  • cover_art_embargo date
  • product_details_embargo date
  • project_id integer or null
  • partners partners object
    • partners.excluded boolean
    • partners.partner_names array of strings
  • release_price_tier string or null
  • track_price_tier string or null

    Digital configurations only.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • cover_art cover_art object
    • cover_art.title string or null
    • cover_art.resource_number string or null
    • cover_art.parental_advisory string or null

      A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.artist_display_name string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.internal_synopsis string or null

      Summary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.series string or null
    • translations.title string or null
    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.video_long_description string or null
    • translations.video_network string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_rating_reason string or null
    • translations.video_short_description string or null
  • discs array of discs objects

    Discs associate tracks (via disc_tracks) to releases. A release may have 1 or more discs, and those discs may have 1 or more tracks (via disc_tracks).

    • discs.number integer or null
    • discs.upc string or null

      Individual discs on multi-disc releases may sometimes have separate UPCs. They may be internal tracking UPCs rather than registered product UPCs.

    • discs.disc_tracks array of disc_tracks objects

      disc_tracks associate tracks to release via discs (hence the name disc_tracks). They also hold information about the track-on-the-release such as the track number, whether the track is a hidden track, various rights details, etc...

      • discs.disc_tracks.number integer or null
      • discs.disc_tracks.side integer or string or null

        The side this track belongs to (for double-sided release configurations). Can be any of A, B, 1, or 2.

      • discs.disc_tracks.track_id integer
      • discs.disc_tracks.global_instant_grat_date date
      • discs.disc_tracks.global_prestream_date date
      • discs.disc_tracks.territory_rights array of territory_rights objects
        • discs.disc_tracks.territory_rights.region_id integer or null
        • discs.disc_tracks.territory_rights.legal boolean
        • discs.disc_tracks.territory_rights.prestream_date date

          The date this track becomes available to Pre-Stream

        • discs.disc_tracks.territory_rights.instant_grat_date date

          The date this track becomes available for Instant Grat

        • discs.disc_tracks.territory_rights.sellable boolean

          If this Track can be sold separately

        • discs.disc_tracks.territory_rights.download boolean

          If this Track has Permanent Download rights

        • discs.disc_tracks.territory_rights.streaming boolean

          If this Track has Subscription streaming rights

        • discs.disc_tracks.territory_rights.ad_supported_streaming boolean

          If this Track has Ad Supported streaming rights

        • discs.disc_tracks.territory_rights.user_generated_video string or null

          User Generated Video rights

      • discs.disc_tracks.track Track object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "title": "If That's What It Takes", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": null, "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": "Smooth Records Group", "cover_art": { "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }, "discs": [ { "disc_tracks": [ { "track": { "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": "Ed Sanford", "affiliation": "BMG", "split_percentage": 50.0, "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD" }, { "artist": "Michael McDonald", "affiliation": "BMG", "split_percentage": null, "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment" } ], "publishers": [ { "publisher": "Yacht Times", "rights_administrator": "SESAC", "affiliation": "BMG", "split_percentage": 100.0, "territory": "only", "restrictions": [ "US" ] } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": null, "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "display_title": "Playin' by the Rules Special Edition", "version_display_title": "Special Bonus Edition", "duration": "PT3M48S", "preview_in": "PT43S", "sample_length": "PT30S", "other_recording_locations": [ "FR", "DE" ], "session_performance_type": "Vocal", "session_type": "Studio", "music_type": "pop", "audio_presentation": "Stereo", "version_title": "Bonus Edition", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true }, { "artist": "Ed Sanford", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ], "rights_holders": [ { "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08", "region_id": 1 } ] } ], "upc": "000000000017" } ], "display_title": "Michael McDonald New Soul Classics", "version_display_title": "Special Edition", "series_name": "Soul Classics", "release_time": "12:30:00", "promotional": true, "distribution_group": "New Releases", "rights_period": "perpetuity", "partner_restrictions": "Apple & Tower Records", "distribution_notes": "Limited to 300 copies", "license": "Owned", "track_listing_embargo": "1981-11-05", "project_id": 600001, "version_title": "API Version", "metadata_language_country": "US", "catalog_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize" }, "region_id": 1 } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] }

Response example

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null, "number": "MP-54321-1" }, "number": "P-12345-1" }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] }

Get a Release Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/releases/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Query parameters

  • include_files boolean

    Send include_files=true to have the response include signed, temporary download URLs for all associated files (release cover art, track audio, etc) in the response. By default no file URLs will be included in the response.

  • include_deleted boolean

    Send include_deleted=true to retrieve records that have been deleted. Otherwise attempting to access a deleted record will result in a 410 error response code.

Response attributes

  • title string
  • configuration string

    The main release type. Different release configurations have different features and validations (for instance audio vs video configurations).

  • label string
  • display_title string or null
  • version_title string or null

    Used to distinguish multiple versions of the same record. (Example: 'Live')

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • series_name string or null

    Name of the Series (Example: 'Greatest Hits Collection')

  • release_date date

    Primary release date associated with the Release

  • release_time time
  • original_release_date date

    The date this Release was originally released if previously released.

  • artist_display_name string or null
  • artist_type string or null
  • name_format string or null
  • upc string or null

    UPC (US 12-digit code with optional leading zeros) or EAN (Europe 13-digit code with optional leading zero)

  • catalog_number string or null

    A local release number or catalog number used internally to uniquely identify the release

  • music_type string or null

    Type of Music (May impact available metadata fields)

  • audio_language string or null

    Primary language of recorded audio

  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • compilation_type string or null

    Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

  • cover_art_id integer or null

    ID of associated Cover Art record. Use to associate a Cover Art record with a Release. Search Art Resources to find Cover Art records.

  • parental_advisory string or null
  • promotional boolean

    If checked, this Release is a promotion (non-commercial) release

  • box_set boolean

    If checked, this Release is part of a box set

  • indie_exclusive boolean

    If checked, this Release is an Indie Exclusive

  • soundtrack boolean

    If checked, this Release contains audio used for the soundtrack of a Film or Television show

  • audio_presentation string or null

    The format of the associated audio

  • resolution_type string or null

    The type of HD content. Digital configurations only.

  • studio string or null

    Studio Name for MFiT Releases. Digital configurations only.

  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • internal_synopsis string or null

    Summary information meant for internal use. This data is not passed to downstream systems or partners.

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • distribution_group string or null
  • territory_rights array of territory_rights objects
    • territory_rights.region_id integer
    • territory_rights.legal boolean
    • territory_rights.release_date date

      The primary release date associated with this Release

    • territory_rights.preorder_date date

      Date at which the release becomes available for Pre-Order

    • territory_rights.distribution_territory boolean
    • territory_rights.default_track_territory_rights default_track_territory_rights object
      • territory_rights.default_track_territory_rights.legal boolean
      • territory_rights.default_track_territory_rights.prestream_date date

        The date this track becomes available to Pre-Stream

      • territory_rights.default_track_territory_rights.instant_grat_date date

        The date this track becomes available for Instant Grat

      • territory_rights.default_track_territory_rights.sellable boolean

        If this Track can be sold separately

      • territory_rights.default_track_territory_rights.download boolean

        If this Track has Permanent Download rights

      • territory_rights.default_track_territory_rights.streaming boolean

        If this Track has Subscription streaming rights

      • territory_rights.default_track_territory_rights.ad_supported_streaming boolean

        If this Track has Ad Supported streaming rights

      • territory_rights.default_track_territory_rights.user_generated_video string or null

        User Generated Video rights

  • rights_period string or null
  • rights_expiry_rule string or null
  • lost_rights boolean

    e.g. "The license has expired and you've lost the right to distribute this release"

  • lost_rights_on date
  • lost_rights_reason string or null
  • partner_restrictions string or null
  • distribution_notes string or null
  • license string or null
  • license_start date
  • license_expiration date
  • track_listing_embargo date
  • audio_embargo date
  • cover_art_embargo date
  • product_details_embargo date
  • project_id integer or null
  • partners partners object
    • partners.excluded boolean
    • partners.partner_names array of strings
  • release_price_tier string or null
  • track_price_tier string or null

    Digital configurations only.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • cover_art cover_art object
    • cover_art.title string or null
    • cover_art.resource_number string or null
    • cover_art.parental_advisory string or null

      A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.artist_display_name string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.internal_synopsis string or null

      Summary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.series string or null
    • translations.title string or null
    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.video_long_description string or null
    • translations.video_network string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_rating_reason string or null
    • translations.video_short_description string or null
  • discs array of discs objects

    Discs associate tracks (via disc_tracks) to releases. A release may have 1 or more discs, and those discs may have 1 or more tracks (via disc_tracks).

    • discs.id integer or null

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • discs.number integer or null
    • discs.upc string or null

      Individual discs on multi-disc releases may sometimes have separate UPCs. They may be internal tracking UPCs rather than registered product UPCs.

    • discs.disc_tracks array of disc_tracks objects

      disc_tracks associate tracks to release via discs (hence the name disc_tracks). They also hold information about the track-on-the-release such as the track number, whether the track is a hidden track, various rights details, etc...

      • discs.disc_tracks.id integer or null

        Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

      • discs.disc_tracks.number integer or null
      • discs.disc_tracks.side integer or string or null

        The side this track belongs to (for double-sided release configurations). Can be any of A, B, 1, or 2.

      • discs.disc_tracks.track_id integer
      • discs.disc_tracks.global_instant_grat_date date
      • discs.disc_tracks.global_prestream_date date
      • discs.disc_tracks.territory_rights array of territory_rights objects
        • discs.disc_tracks.territory_rights.region_id integer or null
        • discs.disc_tracks.territory_rights.legal boolean
        • discs.disc_tracks.territory_rights.prestream_date date

          The date this track becomes available to Pre-Stream

        • discs.disc_tracks.territory_rights.instant_grat_date date

          The date this track becomes available for Instant Grat

        • discs.disc_tracks.territory_rights.sellable boolean

          If this Track can be sold separately

        • discs.disc_tracks.territory_rights.download boolean

          If this Track has Permanent Download rights

        • discs.disc_tracks.territory_rights.streaming boolean

          If this Track has Subscription streaming rights

        • discs.disc_tracks.territory_rights.ad_supported_streaming boolean

          If this Track has Ad Supported streaming rights

        • discs.disc_tracks.territory_rights.user_generated_video string or null

          User Generated Video rights

      • discs.disc_tracks.track Track object
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • number integer

    (Package releases only)

    When a release is a component of a package release this field denotes the component sequence order

  • components array of Release objects

    (Package releases only)

    Components associate releases with a bundle/package release. Existing releases can be added to a Bundle as components using the release_id parameter or new releases can be created using the release parameter.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/6000695/ \ -u {API Key Id}

Response example

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null, "number": "MP-54321-1" }, "number": "P-12345-1" }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] }

Edit a Release Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/releases/{id}/

Similar to Create a Release the Edit a Release JSON schema can optionally include many of the related Release records (Tracks, Works, Art Resources, etc...). This way the Edit a Release API can be used to both change which records are associated with a Release and to add new records associated to the Release in a single request.

Associated records are not editable via this API however. Any values sent for associated records will always be used to create new records associated with the Release. Editing associated records must be done via the API Edit endpoints for those records.

Changing associations or adding existing associations (for instance associating this Release with an existing Cover Art record, or adding multiple existing tracks to this Release) is also possible by passing the IDs of the associated records, as described in the JSON schema.

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • title string
  • configuration string

    The main release type. Different release configurations have different features and validations (for instance audio vs video configurations).

  • label string
  • display_title string or null
  • version_title string or null

    Used to distinguish multiple versions of the same record. (Example: 'Live')

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • series_name string or null

    Name of the Series (Example: 'Greatest Hits Collection')

  • release_date date

    Primary release date associated with the Release

  • release_time time
  • original_release_date date

    The date this Release was originally released if previously released.

  • artist_display_name string or null
  • artist_type string or null
  • name_format string or null
  • upc string or null

    UPC (US 12-digit code with optional leading zeros) or EAN (Europe 13-digit code with optional leading zero)

  • catalog_number string or null

    A local release number or catalog number used internally to uniquely identify the release

  • music_type string or null

    Type of Music (May impact available metadata fields)

  • audio_language string or null

    Primary language of recorded audio

  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • compilation_type string or null

    Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

  • cover_art_id integer or null

    ID of associated Cover Art record. Use to associate a Cover Art record with a Release. Search Art Resources to find Cover Art records.

  • parental_advisory string or null
  • promotional boolean

    If checked, this Release is a promotion (non-commercial) release

  • box_set boolean

    If checked, this Release is part of a box set

  • indie_exclusive boolean

    If checked, this Release is an Indie Exclusive

  • soundtrack boolean

    If checked, this Release contains audio used for the soundtrack of a Film or Television show

  • audio_presentation string or null

    The format of the associated audio

  • resolution_type string or null

    The type of HD content. Digital configurations only.

  • studio string or null

    Studio Name for MFiT Releases. Digital configurations only.

  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • internal_synopsis string or null

    Summary information meant for internal use. This data is not passed to downstream systems or partners.

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • distribution_group string or null
  • territory_rights array of territory_rights objects
    • territory_rights.region_id integer
    • territory_rights.legal boolean
    • territory_rights.release_date date

      The primary release date associated with this Release

    • territory_rights.preorder_date date

      Date at which the release becomes available for Pre-Order

    • territory_rights.distribution_territory boolean
    • territory_rights.default_track_territory_rights default_track_territory_rights object
      • territory_rights.default_track_territory_rights.legal boolean
      • territory_rights.default_track_territory_rights.prestream_date date

        The date this track becomes available to Pre-Stream

      • territory_rights.default_track_territory_rights.instant_grat_date date

        The date this track becomes available for Instant Grat

      • territory_rights.default_track_territory_rights.sellable boolean

        If this Track can be sold separately

      • territory_rights.default_track_territory_rights.download boolean

        If this Track has Permanent Download rights

      • territory_rights.default_track_territory_rights.streaming boolean

        If this Track has Subscription streaming rights

      • territory_rights.default_track_territory_rights.ad_supported_streaming boolean

        If this Track has Ad Supported streaming rights

      • territory_rights.default_track_territory_rights.user_generated_video string or null

        User Generated Video rights

  • rights_period string or null
  • rights_expiry_rule string or null
  • lost_rights boolean

    e.g. "The license has expired and you've lost the right to distribute this release"

  • lost_rights_on date
  • lost_rights_reason string or null
  • partner_restrictions string or null
  • distribution_notes string or null
  • license string or null
  • license_start date
  • license_expiration date
  • track_listing_embargo date
  • audio_embargo date
  • cover_art_embargo date
  • product_details_embargo date
  • project_id integer or null
  • partners partners object
    • partners.excluded boolean
    • partners.partner_names array of strings
  • release_price_tier string or null
  • track_price_tier string or null

    Digital configurations only.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • cover_art cover_art object
    • cover_art.title string or null
    • cover_art.resource_number string or null
    • cover_art.parental_advisory string or null

      A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.artist_display_name string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.internal_synopsis string or null

      Summary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.series string or null
    • translations.title string or null
    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.video_long_description string or null
    • translations.video_network string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_rating_reason string or null
    • translations.video_short_description string or null
  • discs array of discs objects

    Discs associate tracks (via disc_tracks) to releases. A release may have 1 or more discs, and those discs may have 1 or more tracks (via disc_tracks).

    • discs.id integer or null

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • discs.number integer or null
    • discs.upc string or null

      Individual discs on multi-disc releases may sometimes have separate UPCs. They may be internal tracking UPCs rather than registered product UPCs.

    • discs.disc_tracks array of disc_tracks objects

      disc_tracks associate tracks to release via discs (hence the name disc_tracks). They also hold information about the track-on-the-release such as the track number, whether the track is a hidden track, various rights details, etc...

      • discs.disc_tracks.id integer or null

        Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

      • discs.disc_tracks.number integer or null
      • discs.disc_tracks.side integer or string or null

        The side this track belongs to (for double-sided release configurations). Can be any of A, B, 1, or 2.

      • discs.disc_tracks.track_id integer
      • discs.disc_tracks.global_instant_grat_date date
      • discs.disc_tracks.global_prestream_date date
      • discs.disc_tracks.territory_rights array of territory_rights objects
        • discs.disc_tracks.territory_rights.region_id integer or null
        • discs.disc_tracks.territory_rights.legal boolean
        • discs.disc_tracks.territory_rights.prestream_date date

          The date this track becomes available to Pre-Stream

        • discs.disc_tracks.territory_rights.instant_grat_date date

          The date this track becomes available for Instant Grat

        • discs.disc_tracks.territory_rights.sellable boolean

          If this Track can be sold separately

        • discs.disc_tracks.territory_rights.download boolean

          If this Track has Permanent Download rights

        • discs.disc_tracks.territory_rights.streaming boolean

          If this Track has Subscription streaming rights

        • discs.disc_tracks.territory_rights.ad_supported_streaming boolean

          If this Track has Ad Supported streaming rights

        • discs.disc_tracks.territory_rights.user_generated_video string or null

          User Generated Video rights

      • discs.disc_tracks.track Track object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/6000695/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "title": "If That's What It Takes", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": null, "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": "Smooth Records Group", "cover_art": { "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }, "discs": [ { "disc_tracks": [ { "track": { "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": "Ed Sanford", "affiliation": "BMG", "split_percentage": 50.0, "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD" }, { "artist": "Michael McDonald", "affiliation": "BMG", "split_percentage": null, "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment" } ], "publishers": [ { "publisher": "Yacht Times", "rights_administrator": "SESAC", "affiliation": "BMG", "split_percentage": 100.0, "territory": "only", "restrictions": [ "US" ] } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": null, "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "display_title": "Playin' by the Rules Special Edition", "version_display_title": "Special Bonus Edition", "duration": "PT3M48S", "preview_in": "PT43S", "sample_length": "PT30S", "other_recording_locations": [ "FR", "DE" ], "session_performance_type": "Vocal", "session_type": "Studio", "music_type": "pop", "audio_presentation": "Stereo", "version_title": "Bonus Edition", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true }, { "artist": "Ed Sanford", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ], "rights_holders": [ { "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08", "region_id": 1 } ] } ], "upc": "000000000017" } ], "display_title": "Michael McDonald New Soul Classics", "version_display_title": "Special Edition", "series_name": "Soul Classics", "release_time": "12:30:00", "promotional": true, "distribution_group": "New Releases", "rights_period": "perpetuity", "partner_restrictions": "Apple & Tower Records", "distribution_notes": "Limited to 300 copies", "license": "Owned", "track_listing_embargo": "1981-11-05", "project_id": 600001, "version_title": "API Version", "metadata_language_country": "US", "catalog_number": "SRG00001", "upc": "123456789012", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize" }, "region_id": 1 } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] }

Response example

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null, "number": "MP-54321-1" }, "number": "P-12345-1" }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] }

Delete a Release Anchor link icon

DELETE https://{subdomain}.openplaymusic.com/connect/v2/releases/{id}/

Soft delete this record. This can be undone using the undelete endpoint. Deleted records do not appear in search by default but can be retrieved by filtering. Attempting to GET a deleted record will return a 410 response unless the include_deleted=true query parameter is passed.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • deleted_reason string or null

    Optional description for why the record was deleted

Response attributes

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_reason string or null

    Optional description for why the record was deleted

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/6000695/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X DELETE \ -d '{"deleted_reason": "Duplicate"}'

Response example

{ "id": 6000695, "deleted_at": "2022-01-11T15:24:23Z", "deleted_reason": "Duplicate" }

Undelete a Release Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/releases/{id}/undelete/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/5000023/undelete/ \ -u {API Key Id} \ -X PUT

Response example

{ "id": 5000023, "title": "If That's What It Takes", "status": "Draft" }

Get Release distribution validation errors Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/releases/{id}/validate/

Check whether a release is valid for distribution and return any distribution validation errors that would need to be fixed before the release is able to be distributed.

Distribution validation errors are different than the errors returned from other API endpoints that prevent records from being saved. Records can still be saved, but not necessarily be valid to be distributed.

Distribution requirements depend on many factors across the entire release structure; such as the distributor the release will be distributed through, available features, the release configuration, the makeup of tracks on the release, and many more. Distribution requirements also change over time as distributors and retailers change their rules, so a release may be valid for distribution at one time and then become invalid at a later date.

In order to distribute any release it must be valid for distribution at the time it is distributed.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/5000001/validate/ \ -u {API Key Id}

Response example

{ "valid_for_distribution": false, "distribution_validation_errors": { "upc": [ "Required" ] } }

Validate a Release for distribution Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/releases/{id}/validate/

Validate a release for distribution and return any distribution validation errors that would need to be fixed before the release is able to be distributed. If there are no distribution validation errors the release's status will be updated to Validated and it is ready to be distributed. The release can no longer be edited while it is in a Validated state.

Distribution validation errors are different than the errors returned from other API endpoints that prevent records from being saved. Records can still be saved, but not necessarily be valid to be distributed.

Distribution requirements depend on many factors across the entire release structure; such as the distributor the release will be distributed through, available features, the release configuration, the makeup of tracks on the release, and many more. Distribution requirements also change over time as distributors and retailers change their rules, so a release may be valid for distribution at one time and then become invalid at a later date.

In order to distribute any release it must be valid for distribution at the time it is distributed.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/5000001/validate/ \ -u {API Key Id} -X PUT

Response example

{ "valid_for_distribution": false, "distribution_validation_errors": { "upc": [ "Required" ] } }

Submit a Release for distribution Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/releases/{id}/distribute/

Submit a release for distribution. The release status will change to submitted while it goes through a review and approval process. If there are no issues the release will be distributed and the release status will change to distributed .

The release must be valid for distribution . If the release is not valid distribution will fail and respond with the release validation errors.

The release may also be rejected during the review and approval process, in which case the release status will change from submitted to rejected .

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/5000001/distribute/ \ -u {API Key Id} \ -X PUT

Response example

{ "valid_for_distribution": false, "distribution_validation_errors": { "upc": [ "Required" ] } }

Mark a Release as Released (Manually) Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/releases/{id}/released_manually/

Mark a release as Released (Manually). The release status will change to released_manually . This is useful for releases that were distributed outside of the platform but need to be tracked as released.

The release must be in draft or validated status.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/5000001/released_manually/ \ -u {API Key Id} -X PUT

Response example

{ "id": 5000023, "title": "If That's What It Takes", "status": "Released (Manually)" }

Get all Releases* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

Provides an asynchronous bulk API to download all records in a single request. It is much more efficient for syncing an entire catalog than searching and getting individual records.

The bulk API consists of two URLs: a request URL and a status URL. The request URL starts processing the bulk request and then the status URL is used to poll for the processing status. When processing is finished the status response will include a url where the records can be downloaded. The download contains all the records in a single, gzip compressed, JSONL file.

Get all Releases (request)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

POST https://{subdomain}.openplaymusic.com/connect/v2/releases/bulk/

The request URL will begin preparing all records for download. If processing is started the request will return immediately with a 202 status code and a response body with null processed_at and url values.

Processing may take some time. Poll for the current status with the status request.

Single request processing at a time Only one bulk API request can be processed at a time. Requesting another bulk API request while one is being processed will respond with a 409 status code and an error message. Once the request is finished processing another bulk request can be made.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/bulk/ -u {API Key Id} \ -X POST

Response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Get all Releases (status)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

GET https://{subdomain}.openplaymusic.com/connect/v2/releases/bulk/

The status URL allows polling for the status of a bulk records request, and returns the url to download the records once they are ready.

While processing the status URL will respond with a 202 status code and a response body with null values for the processed_at and url keys.

When processing is finished the status URL will respond with a 200 status code, and include a timestamp for the processed_at key, as well as a url where the prepared records can be downloaded.

Depending on catalog size and usage processing bulk requests may take a while. Polling every few minutes is probably sufficient to be notified reasonably quickly and avoid rate limits.

Request expiration Records from a processed bulk request will be available for download for 72 hours. After 72 hours the status URL will return a 404 status code indicating there is no bulk request available. Expiration time is different than processing time -- while only a single bulk request can be processing at any time, additional bulk requests are allowed prior to expiration.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/releases/bulk/ -u {API Key Id}

Processing response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Completed response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": "2025-04-17T29:31:22Z", "url": "https://openplay-example.s3.amazonaws.com/tmp/a1234f12-a123-4f12-a123-4f12a1234f12/releases-2025-04-17-293122.jsonl.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Packages Anchor link icon

Packages are a type of Release that bundle multiple component Releases together. Each component is an ordered reference to a Release and can be created inline or linked to an existing Release by ID. Nearly all Release fields are available on Packages however Packages use the components collection instead of the discs collection.

The Package Object Anchor link icon

Attributes

  • title string
  • configuration string
  • label string
  • display_title string or null
  • version_title string or null

    Used to distinguish multiple versions of the same record. (Example: 'Live')

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • series_name string or null
  • release_date date

    The primary release date associated with this Release

  • release_time time
  • original_release_date date

    The date this Release was originally released if previously released.

  • artist_display_name string or null
  • artist_type string or null
  • name_format string or null
  • upc string or null
  • catalog_number string or null
  • music_type string or null

    Type of Music (May impact available metadata fields)

  • audio_language string or null

    Primary language of recorded audio

  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • compilation_type string or null

    Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

  • cover_art_id integer or null
  • parental_advisory string or null
  • promotional boolean
  • box_set boolean
  • indie_exclusive boolean
  • soundtrack boolean

    If checked, this Release contains audio used for the soundtrack of a Film or Television show

  • audio_presentation string or null

    The format of the associated audio

  • resolution_type string or null
  • studio string or null

    Studio Name for MFiT Releases. Digital configurations only.

  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • internal_synopsis string or null

    Summary information meant for internal use. This data is not passed to downstream systems or partners.

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • distribution_group string or null
  • territory_rights array of territory_rights objects
    • territory_rights.region_id integer
    • territory_rights.legal boolean
    • territory_rights.release_date date

      The primary release date associated with this Release

    • territory_rights.preorder_date date

      Date at which the release becomes available for Pre-Order

    • territory_rights.distribution_territory boolean
    • territory_rights.default_track_territory_rights default_track_territory_rights object
      • territory_rights.default_track_territory_rights.legal boolean
      • territory_rights.default_track_territory_rights.prestream_date date

        The date this track becomes available to Pre-Stream

      • territory_rights.default_track_territory_rights.instant_grat_date date

        The date this track becomes available for Instant Grat

      • territory_rights.default_track_territory_rights.sellable boolean

        If this Track can be sold separately

      • territory_rights.default_track_territory_rights.download boolean

        If this Track has Permanent Download rights

      • territory_rights.default_track_territory_rights.streaming boolean

        If this Track has Subscription streaming rights

      • territory_rights.default_track_territory_rights.ad_supported_streaming boolean

        If this Track has Ad Supported streaming rights

      • territory_rights.default_track_territory_rights.user_generated_video string or null

        User Generated Video rights

  • rights_period string or null
  • rights_expiry_rule string or null
  • lost_rights boolean

    e.g. "The license has expired and you've lost the right to distribute this release"

  • lost_rights_on date
  • lost_rights_reason string or null
  • partner_restrictions string or null
  • distribution_notes string or null
  • license string or null
  • license_start date
  • license_expiration date
  • track_listing_embargo date
  • audio_embargo date
  • cover_art_embargo date
  • product_details_embargo date
  • project_id integer or null
  • partners partners object
    • partners.excluded boolean
    • partners.partner_names array of strings
  • release_price_tier string or null
  • track_price_tier string or null

    Digital configurations only.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • cover_art cover_art object
    • cover_art.title string or null
    • cover_art.resource_number string or null
    • cover_art.parental_advisory string or null

      A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.artist_display_name string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.internal_synopsis string or null

      Summary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.series string or null
    • translations.title string or null
    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.video_long_description string or null
    • translations.video_network string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_rating_reason string or null
    • translations.video_short_description string or null
  • components array of components objects

    Components associate releases with a bundle/package release. Existing releases can be added to a Bundle as components using the release_id parameter or new releases can be created using the release parameter.

    • components.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • components.number integer or null

      The component order number. Component ordering must be sequential

    • components.release_id integer

      ID of associated Release record. Use to associate a Release as a component on a Package Release

    • components.release release object

      The Release object. When creating/editing a Package Release a full representation of a component Release can be passed to create a new Release as a component of the Package

      • components.release.title string
      • components.release.configuration string
      • components.release.label string
      • components.release.display_title string or null
      • components.release.version_title string or null

        Used to distinguish multiple versions of the same record. (Example: 'Live')

      • components.release.version_display_title string or null
      • components.release.display_label string or null

        Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

      • components.release.genre string or null

        genre choice also determines valid sub_genre choices (if available)

      • components.release.sub_genre string or null

        sub_genre choices (if available) are dependent on genre choice.

        See genre for list of valid options.

      • components.release.series_name string or null
      • components.release.release_date date

        The primary release date associated with this Release

      • components.release.release_time time
      • components.release.original_release_date date

        The date this Release was originally released if previously released.

      • components.release.artist_display_name string or null
      • components.release.artist_type string or null
      • components.release.name_format string or null
      • components.release.upc string or null
      • components.release.catalog_number string or null
      • components.release.music_type string or null

        Type of Music (May impact available metadata fields)

      • components.release.audio_language string or null

        Primary language of recorded audio

      • components.release.metadata_language string or null

        Language in which the metadata is written

      • components.release.metadata_language_country string or null

        Country that the Metadata Language is associated with

      • components.release.compilation_type string or null

        Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

      • components.release.cover_art_id integer or null
      • components.release.parental_advisory string or null
      • components.release.promotional boolean
      • components.release.box_set boolean
      • components.release.indie_exclusive boolean
      • components.release.soundtrack boolean

        If checked, this Release contains audio used for the soundtrack of a Film or Television show

      • components.release.audio_presentation string or null

        The format of the associated audio

      • components.release.resolution_type string or null
      • components.release.studio string or null

        Studio Name for MFiT Releases. Digital configurations only.

      • components.release.pline_year integer or null
      • components.release.pline_owner string or null
      • components.release.pline_license string or null
      • components.release.cline_year integer or null
      • components.release.cline_owner string or null
      • components.release.cline_license string or null
      • components.release.vline string or null

        The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

      • components.release.keywords string or null

        Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

      • components.release.internal_synopsis string or null

        Summary information meant for internal use. This data is not passed to downstream systems or partners.

      • components.release.notes string or null

        Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

      • components.release.distribution_group string or null
      • components.release.territory_rights array of territory_rights objects
        • components.release.territory_rights.region_id integer
        • components.release.territory_rights.legal boolean
        • components.release.territory_rights.release_date date

          The primary release date associated with this Release

        • components.release.territory_rights.preorder_date date

          Date at which the release becomes available for Pre-Order

        • components.release.territory_rights.distribution_territory boolean
        • components.release.territory_rights.default_track_territory_rights default_track_territory_rights object
          • components.release.territory_rights.default_track_territory_rights.legal boolean
          • components.release.territory_rights.default_track_territory_rights.prestream_date date

            The date this track becomes available to Pre-Stream

          • components.release.territory_rights.default_track_territory_rights.instant_grat_date date

            The date this track becomes available for Instant Grat

          • components.release.territory_rights.default_track_territory_rights.sellable boolean

            If this Track can be sold separately

          • components.release.territory_rights.default_track_territory_rights.download boolean

            If this Track has Permanent Download rights

          • components.release.territory_rights.default_track_territory_rights.streaming boolean

            If this Track has Subscription streaming rights

          • components.release.territory_rights.default_track_territory_rights.ad_supported_streaming boolean

            If this Track has Ad Supported streaming rights

          • components.release.territory_rights.default_track_territory_rights.user_generated_video string or null

            User Generated Video rights

      • components.release.rights_period string or null
      • components.release.rights_expiry_rule string or null
      • components.release.lost_rights boolean

        e.g. "The license has expired and you've lost the right to distribute this release"

      • components.release.lost_rights_on date
      • components.release.lost_rights_reason string or null
      • components.release.partner_restrictions string or null
      • components.release.distribution_notes string or null
      • components.release.license string or null
      • components.release.license_start date
      • components.release.license_expiration date
      • components.release.track_listing_embargo date
      • components.release.audio_embargo date
      • components.release.cover_art_embargo date
      • components.release.product_details_embargo date
      • components.release.project_id integer or null
      • components.release.partners partners object
        • components.release.partners.excluded boolean
        • components.release.partners.partner_names array of strings
      • components.release.release_price_tier string or null
      • components.release.track_price_tier string or null

        Digital configurations only.

      • components.release.primary_contributions array of primary_contributions objects

        The position of each record is determined by the order of the elements in this array.

        • components.release.primary_contributions.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.primary_contributions.featured boolean
        • components.release.primary_contributions.artist string

          The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

        • components.release.primary_contributions.artist_id integer
      • components.release.contributions array of contributions objects

        The position of each record is determined by the order of the elements in this array.

        • components.release.contributions.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.contributions.role string or null

        • components.release.contributions.type string or null

          More specific Type of Role the artist played. Valid type choice depends on role choice.

          See role for list of valid options.

        • components.release.contributions.artist string

          The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

        • components.release.contributions.artist_id integer
      • components.release.cover_art cover_art object
        • components.release.cover_art.title string or null
        • components.release.cover_art.resource_number string or null
        • components.release.cover_art.parental_advisory string or null

          A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

      • components.release.partner_ids array of partner_ids objects

        Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

        Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

        • components.release.partner_ids.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.partner_ids.name string

          The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

        • components.release.partner_ids.value string

          The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

      • components.release.translations array of translations objects

        Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

        • components.release.translations.language string

          Exact name of the translation language

          Options
          language
          Haryanvi
          Garhwali
          Achinese
          Acoli
          Adangme
          Adyghe; Adygei
          Afro-Asiatic languages
          Afrihili
          Guadeloupean Creole French
          Ainu
          Chhattisgarhi
          Akkadian
          Jamaican Creole English
          Aleut
          Algonquian languages
          Southern Altai
          Malaccan Creole Portuguese
          English, Old (ca.450-1100)
          Angika
          Apache languages
          Malvi
          Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
          Plautdietsch
          Mapudungun; Mapuche
          Arapaho
          Artificial languages
          Arawak
          Asturian; Bable; Leonese; Asturleonese
          Athapascan languages
          Australian languages
          Awadhi
          Banda languages
          Bamileke languages
          Baluchi
          Balinese
          Basa
          Baltic languages
          Beja; Bedawiyet
          Bemba
          Berber languages
          Bhojpuri
          Bikol
          Bini; Edo
          Siksika
          Braj
          Batak languages
          Buriat
          Buginese
          Blin; Bilin
          Caddo
          Central American Indian languages
          Galibi Carib
          Caucasian languages
          Cebuano
          Celtic languages
          Chibcha
          Chagatai
          Chuukese
          Mari
          Chinook jargon
          Choctaw
          Chipewyan; Dene Suline
          Cherokee
          Cheyenne
          Chamic languages
          Coptic
          Creoles and pidgins, English based
          Crimean Tatar; Crimean Turkish
          Kashubian
          Cushitic languages
          Dakota
          Dargwa
          Land Dayak languages
          Delaware
          Slave (Athapascan)
          Dogrib
          Dinka
          Dogri
          Dravidian languages
          Lower Sorbian
          Duala
          Dutch, Middle (ca.1050-1350)
          Dyula
          Efik
          Egyptian (Ancient)
          Ekajuk
          Elamite
          English, Middle (1100-1500)
          Ewondo
          Fang
          Fanti
          Filipino; Pilipino
          Finno-Ugrian languages
          Fon
          French, Middle (ca.1400-1600)
          French, Old (842-ca.1400)
          Northern Frisian
          Eastern Frisian
          Friulian
          Ga
          Gayo
          Gbaya
          Germanic languages
          Geez
          Gilbertese
          German, Middle High (ca.1050-1500)
          German, Old High (ca.750-1050)
          Gondi
          Gorontalo
          Gothic
          Grebo
          Greek, Ancient (to 1453)
          Swiss German; Alemannic; Alsatian
          Gwich'in
          Haida
          Hawaiian
          Hiligaynon
          Himachali languages; Western Pahari languages
          Hittite
          Hmong; Mong
          Upper Sorbian
          Hupa
          Iban
          Ijo languages
          Iloko
          Indic languages
          Indo-European languages
          Ingush
          Iranian languages
          Iroquoian languages
          Lojban
          Judeo-Persian
          Judeo-Arabic
          Kara-Kalpak
          Kabyle
          Kachin; Jingpho
          Kamba
          Karen languages
          Kawi
          Kabardian
          Khasi
          Khoisan languages
          Khotanese; Sakan
          Kimbundu
          Konkani
          Kosraean
          Kpelle
          Karachay-Balkar
          Karelian
          Kru languages
          Kurukh
          Kumyk
          Kutenai
          Ladino
          Lahnda
          Lamba
          Lezghian
          Mongo
          Lozi
          Luba-Lulua
          Luiseno
          Lunda
          Luo (Kenya and Tanzania)
          Lushai
          Madurese
          Magahi
          Maithili
          Makasar
          Mandingo
          Austronesian languages
          Masai
          Moksha
          Mandar
          Mende
          Irish, Middle (900-1200)
          Mi'kmaq; Micmac
          Minangkabau
          Uncoded languages
          Mon-Khmer languages
          Manchu
          Manipuri
          Manobo languages
          Mohawk
          Mossi
          Multiple languages
          Munda languages
          Creek
          Mirandese
          Marwari
          Mayan languages
          Erzya
          Nahuatl languages
          North American Indian languages
          Neapolitan
          Low German; Low Saxon; German, Low; Saxon, Low
          Nepal Bhasa; Newari
          Nias
          Niger-Kordofanian languages
          Niuean
          Nogai
          Norse, Old
          N'Ko
          Pedi; Sepedi; Northern Sotho
          Nubian languages
          Classical Newari; Old Newari; Classical Nepal Bhasa
          Nyamwezi
          Nyankole
          Nyoro
          Nzima
          Osage
          Turkish, Ottoman (1500-1928)
          Otomian languages
          Papuan languages
          Pangasinan
          Pahlavi
          Pampanga; Kapampangan
          Papiamento
          Palauan
          Persian, Old (ca.600-400 B.C.)
          Philippine languages
          Phoenician
          Pohnpeian
          Prakrit languages
          Provençal, Old (to 1500)
          Reserved for local use
          Rajasthani
          Rapanui
          Rarotongan; Cook Islands Maori
          Romance languages
          Romany
          Aromanian; Arumanian; Macedo-Romanian
          Sandawe
          Yakut
          South American Indian (Other)
          Salishan languages
          Samaritan Aramaic
          Sasak
          Santali
          Sicilian
          Scots
          Selkup
          Semitic languages
          Irish, Old (to 900)
          Sign Languages
          Shan
          Sidamo
          Siouan languages
          Sino-Tibetan languages
          Slavic languages
          Southern Sami
          Sami languages
          Lule Sami
          Inari Sami
          Skolt Sami
          Soninke
          Sogdian
          Songhai languages
          Sranan Tongo
          Serer
          Nilo-Saharan languages
          Sukuma
          Susu
          Sumerian
          Classical Syriac
          Syriac
          Tai languages
          Timne
          Tereno
          Tetum
          Tigre
          Tiv
          Tokelau
          Klingon; tlhIngan-Hol
          Tlingit
          Tamashek
          Tonga (Nyasa)
          Tok Pisin
          Tsimshian
          Tumbuka
          Tupi languages
          Altaic languages
          Tuvalu
          Tuvinian
          Udmurt
          Ugaritic
          Umbundu
          Undetermined
          Vai
          Votic
          Wakashan languages
          Walamo
          Waray
          Washo
          Sorbian languages
          Kalmyk; Oirat
          Yao
          Yapese
          Yupik languages
          Zapotec
          Blissymbols; Blissymbolics; Bliss
          Zenaga
          Standard Moroccan Tamazight
          Zande languages
          Zuni
          No linguistic content; Not applicable
          Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
          Bantu (African language)
          Burushaski
          Mandarin
          Cantonese
          Serbo-Croat
          Afar
          Abkhazian
          Afrikaans
          Akan
          Albanian
          Amharic
          Arabic
          Aragonese
          Armenian
          Assamese
          Avaric
          Avestan
          Aymara
          Azerbaijani
          Bashkir
          Bambara
          Basque
          Belarusian
          Bengali
          Bihari languages
          Bislama
          Bosnian
          Breton (Celtic language)
          Bulgarian
          Burmese
          Catalan; Valencian
          Chamorro
          Chechen
          Chinese
          Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
          Chuvash
          Cornish
          Corsican
          Cree
          Czech
          Danish
          Divehi; Dhivehi; Maldivian
          Dutch; Flemish
          Dzongkha
          English
          Esperanto
          Estonian
          Ewe
          Faroese
          Fijian
          Finnish
          French
          Western Frisian
          Fulah
          Georgian
          German
          Gaelic; Scottish Gaelic
          Irish
          Galician
          Manx
          Greek, Modern (1453-)
          Guarani
          Gujarati
          Haitian; Haitian Creole
          Hausa
          Hebrew
          Herero
          Hindi
          Hiri Motu
          Croatian
          Hungarian
          Igbo
          Icelandic
          Ido
          Sichuan Yi; Nuosu
          Inuktitut
          Interlingue; Occidental
          Interlingua (International Auxiliary Language Association)
          Indonesian
          Inupiaq
          Italian
          Javanese
          Japanese
          Kalaallisut; Greenlandic
          Kannada
          Kashmiri
          Kanuri
          Kazakh
          Central Khmer
          Kikuyu; Gikuyu
          Kinyarwanda
          Kirghiz; Kyrgyz
          Komi
          Kongo
          Korean
          Kuanyama; Kwanyama
          Kurdish
          Lao
          Latin
          Latvian
          Limburgan; Limburger; Limburgish
          Lingala
          Lithuanian
          Luxembourgish; Letzeburgesch
          Luba-Katanga
          Ganda
          Macedonian
          Marshallese
          Malayalam
          Maori
          Marathi
          Malay
          Malagasy
          Maltese
          Mongolian
          Nauru
          Navajo; Navaho
          Ndebele, South; South Ndebele
          Ndebele, North; North Ndebele
          Ndonga
          Nepali
          Norwegian Nynorsk; Nynorsk, Norwegian
          Bokmål, Norwegian; Norwegian Bokmål
          Norwegian
          Chichewa; Chewa; Nyanja
          Occitan (post 1500); Provençal
          Ojibwa
          Oriya
          Oromo
          Ossetian; Ossetic
          Panjabi; Punjabi
          Persian
          Pali
          Polish
          Portuguese
          Pushto; Pashto
          Quechua
          Romansh
          Romanian; Moldavian; Moldovan
          Rundi
          Russian
          Sango
          Sanskrit
          Sinhala; Sinhalese
          Slovak
          Slovenian
          Northern Sami
          Samoan
          Shona
          Sindhi
          Somali
          Sotho, Southern
          Spanish; Castilian
          Sardinian
          Serbian
          Swati
          Sundanese
          Swahili
          Swedish
          Tahitian
          Tamil
          Tatar
          Telugu
          Tajik
          Tagalog
          Thai
          Tibetan
          Tigrinya
          Tonga (Tonga Islands)
          Tswana
          Tsonga
          Turkmen
          Turkish
          Twi
          Uighur; Uyghur
          Ukrainian
          Urdu
          Uzbek
          Venda
          Vietnamese
          Volapük
          Welsh
          Walloon
          Wolof
          Xhosa
          Yiddish
          Yoruba
          Zhuang; Chuang
          Zulu
          Japanese (Yomigana)
          Chinese (Simplified)
          Chinese (Traditional)
          Montenegrin
          Creoles and pidgins, French-based
          Creoles and pidgins, Portuguese-based
          Creoles and pidgins

        • components.release.translations.artist_display_name string or null
        • components.release.translations.display_title string or null

          Title to be displayed on the online retailer's site or service

        • components.release.translations.cline_license string or null
        • components.release.translations.cline_owner string or null
        • components.release.translations.display_label string or null

          Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

        • components.release.translations.internal_synopsis string or null

          Summary information meant for internal use. This data is not passed to downstream systems or partners.

        • components.release.translations.notes string or null

          Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

        • components.release.translations.pline_license string or null
        • components.release.translations.pline_owner string or null
        • components.release.translations.series string or null
        • components.release.translations.title string or null
        • components.release.translations.version string or null

          Used to distinguish multiple versions of the same record. (Example: 'Live')

        • components.release.translations.version_display_title string or null

          Version to be displayed on the online retailer's site or service. (Example: 'Live')

        • components.release.translations.video_long_description string or null
        • components.release.translations.video_network string or null
        • components.release.translations.video_production_company string or null

          The company that produced this release

        • components.release.translations.video_rating_reason string or null
        • components.release.translations.video_short_description string or null
      • components.release.discs array of discs objects

        Discs associate tracks (via disc_tracks) to releases. A release may have 1 or more discs, and those discs may have 1 or more tracks (via disc_tracks).

        • components.release.discs.id integer or null

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.discs.number integer or null
        • components.release.discs.upc string or null

          Individual discs on multi-disc releases may sometimes have separate UPCs. They may be internal tracking UPCs rather than registered product UPCs.

        • components.release.discs.disc_tracks array of disc_tracks objects

          disc_tracks associate tracks to release via discs (hence the name disc_tracks). They also hold information about the track-on-the-release such as the track number, whether the track is a hidden track, various rights details, etc...

          • components.release.discs.disc_tracks.id integer or null

            Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

          • components.release.discs.disc_tracks.number integer or null
          • components.release.discs.disc_tracks.side integer or string or null

            The side this track belongs to (for double-sided release configurations). Can be any of A, B, 1, or 2.

          • components.release.discs.disc_tracks.track_id integer
          • components.release.discs.disc_tracks.global_instant_grat_date date
          • components.release.discs.disc_tracks.global_prestream_date date
          • components.release.discs.disc_tracks.territory_rights array of territory_rights objects
            • components.release.discs.disc_tracks.territory_rights.region_id integer or null
            • components.release.discs.disc_tracks.territory_rights.legal boolean
            • components.release.discs.disc_tracks.territory_rights.prestream_date date

              The date this track becomes available to Pre-Stream

            • components.release.discs.disc_tracks.territory_rights.instant_grat_date date

              The date this track becomes available for Instant Grat

            • components.release.discs.disc_tracks.territory_rights.sellable boolean

              If this Track can be sold separately

            • components.release.discs.disc_tracks.territory_rights.download boolean

              If this Track has Permanent Download rights

            • components.release.discs.disc_tracks.territory_rights.streaming boolean

              If this Track has Subscription streaming rights

            • components.release.discs.disc_tracks.territory_rights.ad_supported_streaming boolean

              If this Track has Ad Supported streaming rights

            • components.release.discs.disc_tracks.territory_rights.user_generated_video string or null

              User Generated Video rights

          • components.release.discs.disc_tracks.track Track object
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

The Package Object

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Bundle)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "components": [ { "id": 6000200, "number": 1, "release": { "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Disc 1)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } }, { "id": 6000201, "number": 2, "release": { "id": 6000692, "title": "If That's What It Takes (Disc 2)", "deleted_at": null, "version": null, "pline_year": null, "pline_owner": null, "pline_license": null, "cline_year": null, "cline_owner": null, "cline_license": null, "vline": null, "artist_display_name": null, "genre": null, "sub_genre": null, "metadata_language": null, "audio_language": null, "metadata_language_country": null, "contributions": [], "display_label": null, "release_number": null, "music_type": "pop", "audio_presentation": null, "resolution_type": null, "internal_synopsis": null, "notes": null, "compilation_type": null, "created_at": "2026-06-01T20:16:10Z", "updated_at": "2026-06-01T20:16:10Z", "parental_advisory": "Non-Applicable", "label": { "id": 6000577, "name": "Smooth Records Group" }, "configuration": "eAlbum (audio)", "keywords": null, "upc": null, "translations": [], "studio_name": null, "preorder": false, "earliest_preorder_date": null, "release_date": null, "original_release_date": null, "reissue_date": null, "project": null, "release_price_tier": null, "territory_rights": [], "status": "Draft", "discs": [ { "id": 6000283, "number": 1, "upc": null, "disc_tracks": [] } ] } } ] }

Search Packages Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/packages/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[title] string

    Title to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • filters[upc] string

    UPC to filter by

  • filters[project_number] string

    Project Number to filter by

  • filters[label][] string
  • filters[keywords][] string

    Pass an array of Keywords to filter by

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.title string
    • results.upc string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/packages/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/packages/ \ -u {API Key Id} \ -G \ -d "q=If+Thats+What+It+Takes" \ -d "filters[upc]=555555555555" \ -d "filters[label][]=Smooth+Records+Group"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/packages/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/packages/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000023, "title": "If That's What It Takes (Bundle)", "upc": null } ] }

Create a Package Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/packages/

Packages are releases that bundle multiple component releases together. Each component references an existing Release (via release_id) or creates a new one inline (via release). Components are numbered sequentially starting at 1.

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • title string
  • configuration string
  • label string
  • display_title string or null
  • version_title string or null

    Used to distinguish multiple versions of the same record. (Example: 'Live')

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • series_name string or null
  • release_date date

    The primary release date associated with this Release

  • release_time time
  • original_release_date date

    The date this Release was originally released if previously released.

  • artist_display_name string or null
  • artist_type string or null
  • name_format string or null
  • upc string or null
  • catalog_number string or null
  • music_type string or null

    Type of Music (May impact available metadata fields)

  • audio_language string or null

    Primary language of recorded audio

  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • compilation_type string or null

    Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

  • cover_art_id integer or null
  • parental_advisory string or null
  • promotional boolean
  • box_set boolean
  • indie_exclusive boolean
  • soundtrack boolean

    If checked, this Release contains audio used for the soundtrack of a Film or Television show

  • audio_presentation string or null

    The format of the associated audio

  • resolution_type string or null
  • studio string or null

    Studio Name for MFiT Releases. Digital configurations only.

  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • internal_synopsis string or null

    Summary information meant for internal use. This data is not passed to downstream systems or partners.

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • distribution_group string or null
  • territory_rights array of territory_rights objects
    • territory_rights.region_id integer
    • territory_rights.legal boolean
    • territory_rights.release_date date

      The primary release date associated with this Release

    • territory_rights.preorder_date date

      Date at which the release becomes available for Pre-Order

    • territory_rights.distribution_territory boolean
    • territory_rights.default_track_territory_rights default_track_territory_rights object
      • territory_rights.default_track_territory_rights.legal boolean
      • territory_rights.default_track_territory_rights.prestream_date date

        The date this track becomes available to Pre-Stream

      • territory_rights.default_track_territory_rights.instant_grat_date date

        The date this track becomes available for Instant Grat

      • territory_rights.default_track_territory_rights.sellable boolean

        If this Track can be sold separately

      • territory_rights.default_track_territory_rights.download boolean

        If this Track has Permanent Download rights

      • territory_rights.default_track_territory_rights.streaming boolean

        If this Track has Subscription streaming rights

      • territory_rights.default_track_territory_rights.ad_supported_streaming boolean

        If this Track has Ad Supported streaming rights

      • territory_rights.default_track_territory_rights.user_generated_video string or null

        User Generated Video rights

  • rights_period string or null
  • rights_expiry_rule string or null
  • lost_rights boolean

    e.g. "The license has expired and you've lost the right to distribute this release"

  • lost_rights_on date
  • lost_rights_reason string or null
  • partner_restrictions string or null
  • distribution_notes string or null
  • license string or null
  • license_start date
  • license_expiration date
  • track_listing_embargo date
  • audio_embargo date
  • cover_art_embargo date
  • product_details_embargo date
  • project_id integer or null
  • partners partners object
    • partners.excluded boolean
    • partners.partner_names array of strings
  • release_price_tier string or null
  • track_price_tier string or null

    Digital configurations only.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • cover_art cover_art object
    • cover_art.title string or null
    • cover_art.resource_number string or null
    • cover_art.parental_advisory string or null

      A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.artist_display_name string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.internal_synopsis string or null

      Summary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.series string or null
    • translations.title string or null
    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.video_long_description string or null
    • translations.video_network string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_rating_reason string or null
    • translations.video_short_description string or null
  • components array of components objects

    Components associate releases with a bundle/package release. Existing releases can be added to a Bundle as components using the release_id parameter or new releases can be created using the release parameter.

    • components.number integer or null

      The component order number. Component ordering must be sequential

    • components.release_id integer

      ID of associated Release record. Use to associate a Release as a component on a Package Release

    • components.release release object

      The Release object. When creating/editing a Package Release a full representation of a component Release can be passed to create a new Release as a component of the Package

      • components.release.title string
      • components.release.configuration string
      • components.release.label string
      • components.release.display_title string or null
      • components.release.version_title string or null

        Used to distinguish multiple versions of the same record. (Example: 'Live')

      • components.release.version_display_title string or null
      • components.release.display_label string or null

        Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

      • components.release.genre string or null

        genre choice also determines valid sub_genre choices (if available)

      • components.release.sub_genre string or null

        sub_genre choices (if available) are dependent on genre choice.

        See genre for list of valid options.

      • components.release.series_name string or null
      • components.release.release_date date

        The primary release date associated with this Release

      • components.release.release_time time
      • components.release.original_release_date date

        The date this Release was originally released if previously released.

      • components.release.artist_display_name string or null
      • components.release.artist_type string or null
      • components.release.name_format string or null
      • components.release.upc string or null
      • components.release.catalog_number string or null
      • components.release.music_type string or null

        Type of Music (May impact available metadata fields)

      • components.release.audio_language string or null

        Primary language of recorded audio

      • components.release.metadata_language string or null

        Language in which the metadata is written

      • components.release.metadata_language_country string or null

        Country that the Metadata Language is associated with

      • components.release.compilation_type string or null

        Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

      • components.release.cover_art_id integer or null
      • components.release.parental_advisory string or null
      • components.release.promotional boolean
      • components.release.box_set boolean
      • components.release.indie_exclusive boolean
      • components.release.soundtrack boolean

        If checked, this Release contains audio used for the soundtrack of a Film or Television show

      • components.release.audio_presentation string or null

        The format of the associated audio

      • components.release.resolution_type string or null
      • components.release.studio string or null

        Studio Name for MFiT Releases. Digital configurations only.

      • components.release.pline_year integer or null
      • components.release.pline_owner string or null
      • components.release.pline_license string or null
      • components.release.cline_year integer or null
      • components.release.cline_owner string or null
      • components.release.cline_license string or null
      • components.release.vline string or null

        The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

      • components.release.keywords string or null

        Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

      • components.release.internal_synopsis string or null

        Summary information meant for internal use. This data is not passed to downstream systems or partners.

      • components.release.notes string or null

        Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

      • components.release.distribution_group string or null
      • components.release.territory_rights array of territory_rights objects
        • components.release.territory_rights.region_id integer
        • components.release.territory_rights.legal boolean
        • components.release.territory_rights.release_date date

          The primary release date associated with this Release

        • components.release.territory_rights.preorder_date date

          Date at which the release becomes available for Pre-Order

        • components.release.territory_rights.distribution_territory boolean
        • components.release.territory_rights.default_track_territory_rights default_track_territory_rights object
          • components.release.territory_rights.default_track_territory_rights.legal boolean
          • components.release.territory_rights.default_track_territory_rights.prestream_date date

            The date this track becomes available to Pre-Stream

          • components.release.territory_rights.default_track_territory_rights.instant_grat_date date

            The date this track becomes available for Instant Grat

          • components.release.territory_rights.default_track_territory_rights.sellable boolean

            If this Track can be sold separately

          • components.release.territory_rights.default_track_territory_rights.download boolean

            If this Track has Permanent Download rights

          • components.release.territory_rights.default_track_territory_rights.streaming boolean

            If this Track has Subscription streaming rights

          • components.release.territory_rights.default_track_territory_rights.ad_supported_streaming boolean

            If this Track has Ad Supported streaming rights

          • components.release.territory_rights.default_track_territory_rights.user_generated_video string or null

            User Generated Video rights

      • components.release.rights_period string or null
      • components.release.rights_expiry_rule string or null
      • components.release.lost_rights boolean

        e.g. "The license has expired and you've lost the right to distribute this release"

      • components.release.lost_rights_on date
      • components.release.lost_rights_reason string or null
      • components.release.partner_restrictions string or null
      • components.release.distribution_notes string or null
      • components.release.license string or null
      • components.release.license_start date
      • components.release.license_expiration date
      • components.release.track_listing_embargo date
      • components.release.audio_embargo date
      • components.release.cover_art_embargo date
      • components.release.product_details_embargo date
      • components.release.project_id integer or null
      • components.release.partners partners object
        • components.release.partners.excluded boolean
        • components.release.partners.partner_names array of strings
      • components.release.release_price_tier string or null
      • components.release.track_price_tier string or null

        Digital configurations only.

      • components.release.primary_contributions array of primary_contributions objects

        The position of each record is determined by the order of the elements in this array.

        • components.release.primary_contributions.featured boolean
        • components.release.primary_contributions.artist string

          The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

        • components.release.primary_contributions.artist_id integer
      • components.release.contributions array of contributions objects

        The position of each record is determined by the order of the elements in this array.

        • components.release.contributions.role string or null

        • components.release.contributions.type string or null

          More specific Type of Role the artist played. Valid type choice depends on role choice.

          See role for list of valid options.

        • components.release.contributions.artist string

          The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

        • components.release.contributions.artist_id integer
      • components.release.cover_art cover_art object
        • components.release.cover_art.title string or null
        • components.release.cover_art.resource_number string or null
        • components.release.cover_art.parental_advisory string or null

          A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

      • components.release.partner_ids array of partner_ids objects

        Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

        Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

        • components.release.partner_ids.name string

          The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

        • components.release.partner_ids.value string

          The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

      • components.release.translations array of translations objects

        Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

        • components.release.translations.language string

          Exact name of the translation language

          Options
          language
          Haryanvi
          Garhwali
          Achinese
          Acoli
          Adangme
          Adyghe; Adygei
          Afro-Asiatic languages
          Afrihili
          Guadeloupean Creole French
          Ainu
          Chhattisgarhi
          Akkadian
          Jamaican Creole English
          Aleut
          Algonquian languages
          Southern Altai
          Malaccan Creole Portuguese
          English, Old (ca.450-1100)
          Angika
          Apache languages
          Malvi
          Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
          Plautdietsch
          Mapudungun; Mapuche
          Arapaho
          Artificial languages
          Arawak
          Asturian; Bable; Leonese; Asturleonese
          Athapascan languages
          Australian languages
          Awadhi
          Banda languages
          Bamileke languages
          Baluchi
          Balinese
          Basa
          Baltic languages
          Beja; Bedawiyet
          Bemba
          Berber languages
          Bhojpuri
          Bikol
          Bini; Edo
          Siksika
          Braj
          Batak languages
          Buriat
          Buginese
          Blin; Bilin
          Caddo
          Central American Indian languages
          Galibi Carib
          Caucasian languages
          Cebuano
          Celtic languages
          Chibcha
          Chagatai
          Chuukese
          Mari
          Chinook jargon
          Choctaw
          Chipewyan; Dene Suline
          Cherokee
          Cheyenne
          Chamic languages
          Coptic
          Creoles and pidgins, English based
          Crimean Tatar; Crimean Turkish
          Kashubian
          Cushitic languages
          Dakota
          Dargwa
          Land Dayak languages
          Delaware
          Slave (Athapascan)
          Dogrib
          Dinka
          Dogri
          Dravidian languages
          Lower Sorbian
          Duala
          Dutch, Middle (ca.1050-1350)
          Dyula
          Efik
          Egyptian (Ancient)
          Ekajuk
          Elamite
          English, Middle (1100-1500)
          Ewondo
          Fang
          Fanti
          Filipino; Pilipino
          Finno-Ugrian languages
          Fon
          French, Middle (ca.1400-1600)
          French, Old (842-ca.1400)
          Northern Frisian
          Eastern Frisian
          Friulian
          Ga
          Gayo
          Gbaya
          Germanic languages
          Geez
          Gilbertese
          German, Middle High (ca.1050-1500)
          German, Old High (ca.750-1050)
          Gondi
          Gorontalo
          Gothic
          Grebo
          Greek, Ancient (to 1453)
          Swiss German; Alemannic; Alsatian
          Gwich'in
          Haida
          Hawaiian
          Hiligaynon
          Himachali languages; Western Pahari languages
          Hittite
          Hmong; Mong
          Upper Sorbian
          Hupa
          Iban
          Ijo languages
          Iloko
          Indic languages
          Indo-European languages
          Ingush
          Iranian languages
          Iroquoian languages
          Lojban
          Judeo-Persian
          Judeo-Arabic
          Kara-Kalpak
          Kabyle
          Kachin; Jingpho
          Kamba
          Karen languages
          Kawi
          Kabardian
          Khasi
          Khoisan languages
          Khotanese; Sakan
          Kimbundu
          Konkani
          Kosraean
          Kpelle
          Karachay-Balkar
          Karelian
          Kru languages
          Kurukh
          Kumyk
          Kutenai
          Ladino
          Lahnda
          Lamba
          Lezghian
          Mongo
          Lozi
          Luba-Lulua
          Luiseno
          Lunda
          Luo (Kenya and Tanzania)
          Lushai
          Madurese
          Magahi
          Maithili
          Makasar
          Mandingo
          Austronesian languages
          Masai
          Moksha
          Mandar
          Mende
          Irish, Middle (900-1200)
          Mi'kmaq; Micmac
          Minangkabau
          Uncoded languages
          Mon-Khmer languages
          Manchu
          Manipuri
          Manobo languages
          Mohawk
          Mossi
          Multiple languages
          Munda languages
          Creek
          Mirandese
          Marwari
          Mayan languages
          Erzya
          Nahuatl languages
          North American Indian languages
          Neapolitan
          Low German; Low Saxon; German, Low; Saxon, Low
          Nepal Bhasa; Newari
          Nias
          Niger-Kordofanian languages
          Niuean
          Nogai
          Norse, Old
          N'Ko
          Pedi; Sepedi; Northern Sotho
          Nubian languages
          Classical Newari; Old Newari; Classical Nepal Bhasa
          Nyamwezi
          Nyankole
          Nyoro
          Nzima
          Osage
          Turkish, Ottoman (1500-1928)
          Otomian languages
          Papuan languages
          Pangasinan
          Pahlavi
          Pampanga; Kapampangan
          Papiamento
          Palauan
          Persian, Old (ca.600-400 B.C.)
          Philippine languages
          Phoenician
          Pohnpeian
          Prakrit languages
          Provençal, Old (to 1500)
          Reserved for local use
          Rajasthani
          Rapanui
          Rarotongan; Cook Islands Maori
          Romance languages
          Romany
          Aromanian; Arumanian; Macedo-Romanian
          Sandawe
          Yakut
          South American Indian (Other)
          Salishan languages
          Samaritan Aramaic
          Sasak
          Santali
          Sicilian
          Scots
          Selkup
          Semitic languages
          Irish, Old (to 900)
          Sign Languages
          Shan
          Sidamo
          Siouan languages
          Sino-Tibetan languages
          Slavic languages
          Southern Sami
          Sami languages
          Lule Sami
          Inari Sami
          Skolt Sami
          Soninke
          Sogdian
          Songhai languages
          Sranan Tongo
          Serer
          Nilo-Saharan languages
          Sukuma
          Susu
          Sumerian
          Classical Syriac
          Syriac
          Tai languages
          Timne
          Tereno
          Tetum
          Tigre
          Tiv
          Tokelau
          Klingon; tlhIngan-Hol
          Tlingit
          Tamashek
          Tonga (Nyasa)
          Tok Pisin
          Tsimshian
          Tumbuka
          Tupi languages
          Altaic languages
          Tuvalu
          Tuvinian
          Udmurt
          Ugaritic
          Umbundu
          Undetermined
          Vai
          Votic
          Wakashan languages
          Walamo
          Waray
          Washo
          Sorbian languages
          Kalmyk; Oirat
          Yao
          Yapese
          Yupik languages
          Zapotec
          Blissymbols; Blissymbolics; Bliss
          Zenaga
          Standard Moroccan Tamazight
          Zande languages
          Zuni
          No linguistic content; Not applicable
          Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
          Bantu (African language)
          Burushaski
          Mandarin
          Cantonese
          Serbo-Croat
          Afar
          Abkhazian
          Afrikaans
          Akan
          Albanian
          Amharic
          Arabic
          Aragonese
          Armenian
          Assamese
          Avaric
          Avestan
          Aymara
          Azerbaijani
          Bashkir
          Bambara
          Basque
          Belarusian
          Bengali
          Bihari languages
          Bislama
          Bosnian
          Breton (Celtic language)
          Bulgarian
          Burmese
          Catalan; Valencian
          Chamorro
          Chechen
          Chinese
          Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
          Chuvash
          Cornish
          Corsican
          Cree
          Czech
          Danish
          Divehi; Dhivehi; Maldivian
          Dutch; Flemish
          Dzongkha
          English
          Esperanto
          Estonian
          Ewe
          Faroese
          Fijian
          Finnish
          French
          Western Frisian
          Fulah
          Georgian
          German
          Gaelic; Scottish Gaelic
          Irish
          Galician
          Manx
          Greek, Modern (1453-)
          Guarani
          Gujarati
          Haitian; Haitian Creole
          Hausa
          Hebrew
          Herero
          Hindi
          Hiri Motu
          Croatian
          Hungarian
          Igbo
          Icelandic
          Ido
          Sichuan Yi; Nuosu
          Inuktitut
          Interlingue; Occidental
          Interlingua (International Auxiliary Language Association)
          Indonesian
          Inupiaq
          Italian
          Javanese
          Japanese
          Kalaallisut; Greenlandic
          Kannada
          Kashmiri
          Kanuri
          Kazakh
          Central Khmer
          Kikuyu; Gikuyu
          Kinyarwanda
          Kirghiz; Kyrgyz
          Komi
          Kongo
          Korean
          Kuanyama; Kwanyama
          Kurdish
          Lao
          Latin
          Latvian
          Limburgan; Limburger; Limburgish
          Lingala
          Lithuanian
          Luxembourgish; Letzeburgesch
          Luba-Katanga
          Ganda
          Macedonian
          Marshallese
          Malayalam
          Maori
          Marathi
          Malay
          Malagasy
          Maltese
          Mongolian
          Nauru
          Navajo; Navaho
          Ndebele, South; South Ndebele
          Ndebele, North; North Ndebele
          Ndonga
          Nepali
          Norwegian Nynorsk; Nynorsk, Norwegian
          Bokmål, Norwegian; Norwegian Bokmål
          Norwegian
          Chichewa; Chewa; Nyanja
          Occitan (post 1500); Provençal
          Ojibwa
          Oriya
          Oromo
          Ossetian; Ossetic
          Panjabi; Punjabi
          Persian
          Pali
          Polish
          Portuguese
          Pushto; Pashto
          Quechua
          Romansh
          Romanian; Moldavian; Moldovan
          Rundi
          Russian
          Sango
          Sanskrit
          Sinhala; Sinhalese
          Slovak
          Slovenian
          Northern Sami
          Samoan
          Shona
          Sindhi
          Somali
          Sotho, Southern
          Spanish; Castilian
          Sardinian
          Serbian
          Swati
          Sundanese
          Swahili
          Swedish
          Tahitian
          Tamil
          Tatar
          Telugu
          Tajik
          Tagalog
          Thai
          Tibetan
          Tigrinya
          Tonga (Tonga Islands)
          Tswana
          Tsonga
          Turkmen
          Turkish
          Twi
          Uighur; Uyghur
          Ukrainian
          Urdu
          Uzbek
          Venda
          Vietnamese
          Volapük
          Welsh
          Walloon
          Wolof
          Xhosa
          Yiddish
          Yoruba
          Zhuang; Chuang
          Zulu
          Japanese (Yomigana)
          Chinese (Simplified)
          Chinese (Traditional)
          Montenegrin
          Creoles and pidgins, French-based
          Creoles and pidgins, Portuguese-based
          Creoles and pidgins

        • components.release.translations.artist_display_name string or null
        • components.release.translations.display_title string or null

          Title to be displayed on the online retailer's site or service

        • components.release.translations.cline_license string or null
        • components.release.translations.cline_owner string or null
        • components.release.translations.display_label string or null

          Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

        • components.release.translations.internal_synopsis string or null

          Summary information meant for internal use. This data is not passed to downstream systems or partners.

        • components.release.translations.notes string or null

          Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

        • components.release.translations.pline_license string or null
        • components.release.translations.pline_owner string or null
        • components.release.translations.series string or null
        • components.release.translations.title string or null
        • components.release.translations.version string or null

          Used to distinguish multiple versions of the same record. (Example: 'Live')

        • components.release.translations.version_display_title string or null

          Version to be displayed on the online retailer's site or service. (Example: 'Live')

        • components.release.translations.video_long_description string or null
        • components.release.translations.video_network string or null
        • components.release.translations.video_production_company string or null

          The company that produced this release

        • components.release.translations.video_rating_reason string or null
        • components.release.translations.video_short_description string or null
      • components.release.discs array of discs objects

        Discs associate tracks (via disc_tracks) to releases. A release may have 1 or more discs, and those discs may have 1 or more tracks (via disc_tracks).

        • components.release.discs.number integer or null
        • components.release.discs.upc string or null

          Individual discs on multi-disc releases may sometimes have separate UPCs. They may be internal tracking UPCs rather than registered product UPCs.

        • components.release.discs.disc_tracks array of disc_tracks objects

          disc_tracks associate tracks to release via discs (hence the name disc_tracks). They also hold information about the track-on-the-release such as the track number, whether the track is a hidden track, various rights details, etc...

          • components.release.discs.disc_tracks.number integer or null
          • components.release.discs.disc_tracks.side integer or string or null

            The side this track belongs to (for double-sided release configurations). Can be any of A, B, 1, or 2.

          • components.release.discs.disc_tracks.track_id integer
          • components.release.discs.disc_tracks.global_instant_grat_date date
          • components.release.discs.disc_tracks.global_prestream_date date
          • components.release.discs.disc_tracks.territory_rights array of territory_rights objects
            • components.release.discs.disc_tracks.territory_rights.region_id integer or null
            • components.release.discs.disc_tracks.territory_rights.legal boolean
            • components.release.discs.disc_tracks.territory_rights.prestream_date date

              The date this track becomes available to Pre-Stream

            • components.release.discs.disc_tracks.territory_rights.instant_grat_date date

              The date this track becomes available for Instant Grat

            • components.release.discs.disc_tracks.territory_rights.sellable boolean

              If this Track can be sold separately

            • components.release.discs.disc_tracks.territory_rights.download boolean

              If this Track has Permanent Download rights

            • components.release.discs.disc_tracks.territory_rights.streaming boolean

              If this Track has Subscription streaming rights

            • components.release.discs.disc_tracks.territory_rights.ad_supported_streaming boolean

              If this Track has Ad Supported streaming rights

            • components.release.discs.disc_tracks.territory_rights.user_generated_video string or null

              User Generated Video rights

          • components.release.discs.disc_tracks.track Track object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/packages/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "title": "If That's What It Takes (Bundle)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": null, "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": "Smooth Records Group", "cover_art": { "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }, "display_title": "Michael McDonald New Soul Classics", "version_display_title": "Special Edition", "series_name": "Soul Classics", "release_time": "12:30:00", "promotional": true, "distribution_group": "New Releases", "rights_period": "perpetuity", "partner_restrictions": "Apple & Tower Records", "distribution_notes": "Limited to 300 copies", "license": "Owned", "track_listing_embargo": "1981-11-05", "project_id": 600001, "version_title": "API Version", "metadata_language_country": "US", "catalog_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize" }, "region_id": 1 } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ], "components": [ { "release": { "title": "If That's What It Takes (Disc 1)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": null, "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": "Smooth Records Group", "cover_art": { "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }, "discs": [ { "disc_tracks": [ { "track": { "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": "Ed Sanford", "affiliation": "BMG", "split_percentage": 50.0, "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD" }, { "artist": "Michael McDonald", "affiliation": "BMG", "split_percentage": null, "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment" } ], "publishers": [ { "publisher": "Yacht Times", "rights_administrator": "SESAC", "affiliation": "BMG", "split_percentage": 100.0, "territory": "only", "restrictions": [ "US" ] } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": null, "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "display_title": "Playin' by the Rules Special Edition", "version_display_title": "Special Bonus Edition", "duration": "PT3M48S", "preview_in": "PT43S", "sample_length": "PT30S", "other_recording_locations": [ "FR", "DE" ], "session_performance_type": "Vocal", "session_type": "Studio", "music_type": "pop", "audio_presentation": "Stereo", "version_title": "Bonus Edition", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true }, { "artist": "Ed Sanford", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ], "rights_holders": [ { "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08", "region_id": 1 } ] } ], "upc": "000000000017" } ], "display_title": "Michael McDonald New Soul Classics", "version_display_title": "Special Edition", "series_name": "Soul Classics", "release_time": "12:30:00", "promotional": true, "distribution_group": "New Releases", "rights_period": "perpetuity", "partner_restrictions": "Apple & Tower Records", "distribution_notes": "Limited to 300 copies", "license": "Owned", "track_listing_embargo": "1981-11-05", "project_id": 600001, "version_title": "API Version", "metadata_language_country": "US", "catalog_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize" }, "region_id": 1 } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] } }, { "release_id": 6000101 } ] }

Response example

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Bundle)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "components": [ { "id": 6000200, "number": 1, "release": { "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Disc 1)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } }, { "id": 6000201, "number": 2, "release": { "id": 6000692, "title": "If That's What It Takes (Disc 2)", "deleted_at": null, "version": null, "pline_year": null, "pline_owner": null, "pline_license": null, "cline_year": null, "cline_owner": null, "cline_license": null, "vline": null, "artist_display_name": null, "genre": null, "sub_genre": null, "metadata_language": null, "audio_language": null, "metadata_language_country": null, "contributions": [], "display_label": null, "release_number": null, "music_type": "pop", "audio_presentation": null, "resolution_type": null, "internal_synopsis": null, "notes": null, "compilation_type": null, "created_at": "2026-06-01T20:16:10Z", "updated_at": "2026-06-01T20:16:10Z", "parental_advisory": "Non-Applicable", "label": { "id": 6000577, "name": "Smooth Records Group" }, "configuration": "eAlbum (audio)", "keywords": null, "upc": null, "translations": [], "studio_name": null, "preorder": false, "earliest_preorder_date": null, "release_date": null, "original_release_date": null, "reissue_date": null, "project": null, "release_price_tier": null, "territory_rights": [], "status": "Draft", "discs": [ { "id": 6000283, "number": 1, "upc": null, "disc_tracks": [] } ] } } ] }

Get a Package Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/packages/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Query parameters

  • include_deleted boolean

    Send include_deleted=true to retrieve records that have been deleted. Otherwise attempting to access a deleted record will result in a 410 error response code.

Response attributes

  • title string
  • configuration string
  • label string
  • display_title string or null
  • version_title string or null

    Used to distinguish multiple versions of the same record. (Example: 'Live')

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • series_name string or null
  • release_date date

    The primary release date associated with this Release

  • release_time time
  • original_release_date date

    The date this Release was originally released if previously released.

  • artist_display_name string or null
  • artist_type string or null
  • name_format string or null
  • upc string or null
  • catalog_number string or null
  • music_type string or null

    Type of Music (May impact available metadata fields)

  • audio_language string or null

    Primary language of recorded audio

  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • compilation_type string or null

    Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

  • cover_art_id integer or null
  • parental_advisory string or null
  • promotional boolean
  • box_set boolean
  • indie_exclusive boolean
  • soundtrack boolean

    If checked, this Release contains audio used for the soundtrack of a Film or Television show

  • audio_presentation string or null

    The format of the associated audio

  • resolution_type string or null
  • studio string or null

    Studio Name for MFiT Releases. Digital configurations only.

  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • internal_synopsis string or null

    Summary information meant for internal use. This data is not passed to downstream systems or partners.

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • distribution_group string or null
  • territory_rights array of territory_rights objects
    • territory_rights.region_id integer
    • territory_rights.legal boolean
    • territory_rights.release_date date

      The primary release date associated with this Release

    • territory_rights.preorder_date date

      Date at which the release becomes available for Pre-Order

    • territory_rights.distribution_territory boolean
    • territory_rights.default_track_territory_rights default_track_territory_rights object
      • territory_rights.default_track_territory_rights.legal boolean
      • territory_rights.default_track_territory_rights.prestream_date date

        The date this track becomes available to Pre-Stream

      • territory_rights.default_track_territory_rights.instant_grat_date date

        The date this track becomes available for Instant Grat

      • territory_rights.default_track_territory_rights.sellable boolean

        If this Track can be sold separately

      • territory_rights.default_track_territory_rights.download boolean

        If this Track has Permanent Download rights

      • territory_rights.default_track_territory_rights.streaming boolean

        If this Track has Subscription streaming rights

      • territory_rights.default_track_territory_rights.ad_supported_streaming boolean

        If this Track has Ad Supported streaming rights

      • territory_rights.default_track_territory_rights.user_generated_video string or null

        User Generated Video rights

  • rights_period string or null
  • rights_expiry_rule string or null
  • lost_rights boolean

    e.g. "The license has expired and you've lost the right to distribute this release"

  • lost_rights_on date
  • lost_rights_reason string or null
  • partner_restrictions string or null
  • distribution_notes string or null
  • license string or null
  • license_start date
  • license_expiration date
  • track_listing_embargo date
  • audio_embargo date
  • cover_art_embargo date
  • product_details_embargo date
  • project_id integer or null
  • partners partners object
    • partners.excluded boolean
    • partners.partner_names array of strings
  • release_price_tier string or null
  • track_price_tier string or null

    Digital configurations only.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • cover_art cover_art object
    • cover_art.title string or null
    • cover_art.resource_number string or null
    • cover_art.parental_advisory string or null

      A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.artist_display_name string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.internal_synopsis string or null

      Summary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.series string or null
    • translations.title string or null
    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.video_long_description string or null
    • translations.video_network string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_rating_reason string or null
    • translations.video_short_description string or null
  • components array of components objects

    Components associate releases with a bundle/package release. Existing releases can be added to a Bundle as components using the release_id parameter or new releases can be created using the release parameter.

    • components.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • components.number integer or null

      The component order number. Component ordering must be sequential

    • components.release_id integer

      ID of associated Release record. Use to associate a Release as a component on a Package Release

    • components.release release object

      The Release object. When creating/editing a Package Release a full representation of a component Release can be passed to create a new Release as a component of the Package

      • components.release.title string
      • components.release.configuration string
      • components.release.label string
      • components.release.display_title string or null
      • components.release.version_title string or null

        Used to distinguish multiple versions of the same record. (Example: 'Live')

      • components.release.version_display_title string or null
      • components.release.display_label string or null

        Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

      • components.release.genre string or null

        genre choice also determines valid sub_genre choices (if available)

      • components.release.sub_genre string or null

        sub_genre choices (if available) are dependent on genre choice.

        See genre for list of valid options.

      • components.release.series_name string or null
      • components.release.release_date date

        The primary release date associated with this Release

      • components.release.release_time time
      • components.release.original_release_date date

        The date this Release was originally released if previously released.

      • components.release.artist_display_name string or null
      • components.release.artist_type string or null
      • components.release.name_format string or null
      • components.release.upc string or null
      • components.release.catalog_number string or null
      • components.release.music_type string or null

        Type of Music (May impact available metadata fields)

      • components.release.audio_language string or null

        Primary language of recorded audio

      • components.release.metadata_language string or null

        Language in which the metadata is written

      • components.release.metadata_language_country string or null

        Country that the Metadata Language is associated with

      • components.release.compilation_type string or null

        Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

      • components.release.cover_art_id integer or null
      • components.release.parental_advisory string or null
      • components.release.promotional boolean
      • components.release.box_set boolean
      • components.release.indie_exclusive boolean
      • components.release.soundtrack boolean

        If checked, this Release contains audio used for the soundtrack of a Film or Television show

      • components.release.audio_presentation string or null

        The format of the associated audio

      • components.release.resolution_type string or null
      • components.release.studio string or null

        Studio Name for MFiT Releases. Digital configurations only.

      • components.release.pline_year integer or null
      • components.release.pline_owner string or null
      • components.release.pline_license string or null
      • components.release.cline_year integer or null
      • components.release.cline_owner string or null
      • components.release.cline_license string or null
      • components.release.vline string or null

        The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

      • components.release.keywords string or null

        Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

      • components.release.internal_synopsis string or null

        Summary information meant for internal use. This data is not passed to downstream systems or partners.

      • components.release.notes string or null

        Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

      • components.release.distribution_group string or null
      • components.release.territory_rights array of territory_rights objects
        • components.release.territory_rights.region_id integer
        • components.release.territory_rights.legal boolean
        • components.release.territory_rights.release_date date

          The primary release date associated with this Release

        • components.release.territory_rights.preorder_date date

          Date at which the release becomes available for Pre-Order

        • components.release.territory_rights.distribution_territory boolean
        • components.release.territory_rights.default_track_territory_rights default_track_territory_rights object
          • components.release.territory_rights.default_track_territory_rights.legal boolean
          • components.release.territory_rights.default_track_territory_rights.prestream_date date

            The date this track becomes available to Pre-Stream

          • components.release.territory_rights.default_track_territory_rights.instant_grat_date date

            The date this track becomes available for Instant Grat

          • components.release.territory_rights.default_track_territory_rights.sellable boolean

            If this Track can be sold separately

          • components.release.territory_rights.default_track_territory_rights.download boolean

            If this Track has Permanent Download rights

          • components.release.territory_rights.default_track_territory_rights.streaming boolean

            If this Track has Subscription streaming rights

          • components.release.territory_rights.default_track_territory_rights.ad_supported_streaming boolean

            If this Track has Ad Supported streaming rights

          • components.release.territory_rights.default_track_territory_rights.user_generated_video string or null

            User Generated Video rights

      • components.release.rights_period string or null
      • components.release.rights_expiry_rule string or null
      • components.release.lost_rights boolean

        e.g. "The license has expired and you've lost the right to distribute this release"

      • components.release.lost_rights_on date
      • components.release.lost_rights_reason string or null
      • components.release.partner_restrictions string or null
      • components.release.distribution_notes string or null
      • components.release.license string or null
      • components.release.license_start date
      • components.release.license_expiration date
      • components.release.track_listing_embargo date
      • components.release.audio_embargo date
      • components.release.cover_art_embargo date
      • components.release.product_details_embargo date
      • components.release.project_id integer or null
      • components.release.partners partners object
        • components.release.partners.excluded boolean
        • components.release.partners.partner_names array of strings
      • components.release.release_price_tier string or null
      • components.release.track_price_tier string or null

        Digital configurations only.

      • components.release.primary_contributions array of primary_contributions objects

        The position of each record is determined by the order of the elements in this array.

        • components.release.primary_contributions.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.primary_contributions.featured boolean
        • components.release.primary_contributions.artist string

          The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

        • components.release.primary_contributions.artist_id integer
      • components.release.contributions array of contributions objects

        The position of each record is determined by the order of the elements in this array.

        • components.release.contributions.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.contributions.role string or null

        • components.release.contributions.type string or null

          More specific Type of Role the artist played. Valid type choice depends on role choice.

          See role for list of valid options.

        • components.release.contributions.artist string

          The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

        • components.release.contributions.artist_id integer
      • components.release.cover_art cover_art object
        • components.release.cover_art.title string or null
        • components.release.cover_art.resource_number string or null
        • components.release.cover_art.parental_advisory string or null

          A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

      • components.release.partner_ids array of partner_ids objects

        Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

        Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

        • components.release.partner_ids.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.partner_ids.name string

          The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

        • components.release.partner_ids.value string

          The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

      • components.release.translations array of translations objects

        Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

        • components.release.translations.language string

          Exact name of the translation language

          Options
          language
          Haryanvi
          Garhwali
          Achinese
          Acoli
          Adangme
          Adyghe; Adygei
          Afro-Asiatic languages
          Afrihili
          Guadeloupean Creole French
          Ainu
          Chhattisgarhi
          Akkadian
          Jamaican Creole English
          Aleut
          Algonquian languages
          Southern Altai
          Malaccan Creole Portuguese
          English, Old (ca.450-1100)
          Angika
          Apache languages
          Malvi
          Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
          Plautdietsch
          Mapudungun; Mapuche
          Arapaho
          Artificial languages
          Arawak
          Asturian; Bable; Leonese; Asturleonese
          Athapascan languages
          Australian languages
          Awadhi
          Banda languages
          Bamileke languages
          Baluchi
          Balinese
          Basa
          Baltic languages
          Beja; Bedawiyet
          Bemba
          Berber languages
          Bhojpuri
          Bikol
          Bini; Edo
          Siksika
          Braj
          Batak languages
          Buriat
          Buginese
          Blin; Bilin
          Caddo
          Central American Indian languages
          Galibi Carib
          Caucasian languages
          Cebuano
          Celtic languages
          Chibcha
          Chagatai
          Chuukese
          Mari
          Chinook jargon
          Choctaw
          Chipewyan; Dene Suline
          Cherokee
          Cheyenne
          Chamic languages
          Coptic
          Creoles and pidgins, English based
          Crimean Tatar; Crimean Turkish
          Kashubian
          Cushitic languages
          Dakota
          Dargwa
          Land Dayak languages
          Delaware
          Slave (Athapascan)
          Dogrib
          Dinka
          Dogri
          Dravidian languages
          Lower Sorbian
          Duala
          Dutch, Middle (ca.1050-1350)
          Dyula
          Efik
          Egyptian (Ancient)
          Ekajuk
          Elamite
          English, Middle (1100-1500)
          Ewondo
          Fang
          Fanti
          Filipino; Pilipino
          Finno-Ugrian languages
          Fon
          French, Middle (ca.1400-1600)
          French, Old (842-ca.1400)
          Northern Frisian
          Eastern Frisian
          Friulian
          Ga
          Gayo
          Gbaya
          Germanic languages
          Geez
          Gilbertese
          German, Middle High (ca.1050-1500)
          German, Old High (ca.750-1050)
          Gondi
          Gorontalo
          Gothic
          Grebo
          Greek, Ancient (to 1453)
          Swiss German; Alemannic; Alsatian
          Gwich'in
          Haida
          Hawaiian
          Hiligaynon
          Himachali languages; Western Pahari languages
          Hittite
          Hmong; Mong
          Upper Sorbian
          Hupa
          Iban
          Ijo languages
          Iloko
          Indic languages
          Indo-European languages
          Ingush
          Iranian languages
          Iroquoian languages
          Lojban
          Judeo-Persian
          Judeo-Arabic
          Kara-Kalpak
          Kabyle
          Kachin; Jingpho
          Kamba
          Karen languages
          Kawi
          Kabardian
          Khasi
          Khoisan languages
          Khotanese; Sakan
          Kimbundu
          Konkani
          Kosraean
          Kpelle
          Karachay-Balkar
          Karelian
          Kru languages
          Kurukh
          Kumyk
          Kutenai
          Ladino
          Lahnda
          Lamba
          Lezghian
          Mongo
          Lozi
          Luba-Lulua
          Luiseno
          Lunda
          Luo (Kenya and Tanzania)
          Lushai
          Madurese
          Magahi
          Maithili
          Makasar
          Mandingo
          Austronesian languages
          Masai
          Moksha
          Mandar
          Mende
          Irish, Middle (900-1200)
          Mi'kmaq; Micmac
          Minangkabau
          Uncoded languages
          Mon-Khmer languages
          Manchu
          Manipuri
          Manobo languages
          Mohawk
          Mossi
          Multiple languages
          Munda languages
          Creek
          Mirandese
          Marwari
          Mayan languages
          Erzya
          Nahuatl languages
          North American Indian languages
          Neapolitan
          Low German; Low Saxon; German, Low; Saxon, Low
          Nepal Bhasa; Newari
          Nias
          Niger-Kordofanian languages
          Niuean
          Nogai
          Norse, Old
          N'Ko
          Pedi; Sepedi; Northern Sotho
          Nubian languages
          Classical Newari; Old Newari; Classical Nepal Bhasa
          Nyamwezi
          Nyankole
          Nyoro
          Nzima
          Osage
          Turkish, Ottoman (1500-1928)
          Otomian languages
          Papuan languages
          Pangasinan
          Pahlavi
          Pampanga; Kapampangan
          Papiamento
          Palauan
          Persian, Old (ca.600-400 B.C.)
          Philippine languages
          Phoenician
          Pohnpeian
          Prakrit languages
          Provençal, Old (to 1500)
          Reserved for local use
          Rajasthani
          Rapanui
          Rarotongan; Cook Islands Maori
          Romance languages
          Romany
          Aromanian; Arumanian; Macedo-Romanian
          Sandawe
          Yakut
          South American Indian (Other)
          Salishan languages
          Samaritan Aramaic
          Sasak
          Santali
          Sicilian
          Scots
          Selkup
          Semitic languages
          Irish, Old (to 900)
          Sign Languages
          Shan
          Sidamo
          Siouan languages
          Sino-Tibetan languages
          Slavic languages
          Southern Sami
          Sami languages
          Lule Sami
          Inari Sami
          Skolt Sami
          Soninke
          Sogdian
          Songhai languages
          Sranan Tongo
          Serer
          Nilo-Saharan languages
          Sukuma
          Susu
          Sumerian
          Classical Syriac
          Syriac
          Tai languages
          Timne
          Tereno
          Tetum
          Tigre
          Tiv
          Tokelau
          Klingon; tlhIngan-Hol
          Tlingit
          Tamashek
          Tonga (Nyasa)
          Tok Pisin
          Tsimshian
          Tumbuka
          Tupi languages
          Altaic languages
          Tuvalu
          Tuvinian
          Udmurt
          Ugaritic
          Umbundu
          Undetermined
          Vai
          Votic
          Wakashan languages
          Walamo
          Waray
          Washo
          Sorbian languages
          Kalmyk; Oirat
          Yao
          Yapese
          Yupik languages
          Zapotec
          Blissymbols; Blissymbolics; Bliss
          Zenaga
          Standard Moroccan Tamazight
          Zande languages
          Zuni
          No linguistic content; Not applicable
          Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
          Bantu (African language)
          Burushaski
          Mandarin
          Cantonese
          Serbo-Croat
          Afar
          Abkhazian
          Afrikaans
          Akan
          Albanian
          Amharic
          Arabic
          Aragonese
          Armenian
          Assamese
          Avaric
          Avestan
          Aymara
          Azerbaijani
          Bashkir
          Bambara
          Basque
          Belarusian
          Bengali
          Bihari languages
          Bislama
          Bosnian
          Breton (Celtic language)
          Bulgarian
          Burmese
          Catalan; Valencian
          Chamorro
          Chechen
          Chinese
          Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
          Chuvash
          Cornish
          Corsican
          Cree
          Czech
          Danish
          Divehi; Dhivehi; Maldivian
          Dutch; Flemish
          Dzongkha
          English
          Esperanto
          Estonian
          Ewe
          Faroese
          Fijian
          Finnish
          French
          Western Frisian
          Fulah
          Georgian
          German
          Gaelic; Scottish Gaelic
          Irish
          Galician
          Manx
          Greek, Modern (1453-)
          Guarani
          Gujarati
          Haitian; Haitian Creole
          Hausa
          Hebrew
          Herero
          Hindi
          Hiri Motu
          Croatian
          Hungarian
          Igbo
          Icelandic
          Ido
          Sichuan Yi; Nuosu
          Inuktitut
          Interlingue; Occidental
          Interlingua (International Auxiliary Language Association)
          Indonesian
          Inupiaq
          Italian
          Javanese
          Japanese
          Kalaallisut; Greenlandic
          Kannada
          Kashmiri
          Kanuri
          Kazakh
          Central Khmer
          Kikuyu; Gikuyu
          Kinyarwanda
          Kirghiz; Kyrgyz
          Komi
          Kongo
          Korean
          Kuanyama; Kwanyama
          Kurdish
          Lao
          Latin
          Latvian
          Limburgan; Limburger; Limburgish
          Lingala
          Lithuanian
          Luxembourgish; Letzeburgesch
          Luba-Katanga
          Ganda
          Macedonian
          Marshallese
          Malayalam
          Maori
          Marathi
          Malay
          Malagasy
          Maltese
          Mongolian
          Nauru
          Navajo; Navaho
          Ndebele, South; South Ndebele
          Ndebele, North; North Ndebele
          Ndonga
          Nepali
          Norwegian Nynorsk; Nynorsk, Norwegian
          Bokmål, Norwegian; Norwegian Bokmål
          Norwegian
          Chichewa; Chewa; Nyanja
          Occitan (post 1500); Provençal
          Ojibwa
          Oriya
          Oromo
          Ossetian; Ossetic
          Panjabi; Punjabi
          Persian
          Pali
          Polish
          Portuguese
          Pushto; Pashto
          Quechua
          Romansh
          Romanian; Moldavian; Moldovan
          Rundi
          Russian
          Sango
          Sanskrit
          Sinhala; Sinhalese
          Slovak
          Slovenian
          Northern Sami
          Samoan
          Shona
          Sindhi
          Somali
          Sotho, Southern
          Spanish; Castilian
          Sardinian
          Serbian
          Swati
          Sundanese
          Swahili
          Swedish
          Tahitian
          Tamil
          Tatar
          Telugu
          Tajik
          Tagalog
          Thai
          Tibetan
          Tigrinya
          Tonga (Tonga Islands)
          Tswana
          Tsonga
          Turkmen
          Turkish
          Twi
          Uighur; Uyghur
          Ukrainian
          Urdu
          Uzbek
          Venda
          Vietnamese
          Volapük
          Welsh
          Walloon
          Wolof
          Xhosa
          Yiddish
          Yoruba
          Zhuang; Chuang
          Zulu
          Japanese (Yomigana)
          Chinese (Simplified)
          Chinese (Traditional)
          Montenegrin
          Creoles and pidgins, French-based
          Creoles and pidgins, Portuguese-based
          Creoles and pidgins

        • components.release.translations.artist_display_name string or null
        • components.release.translations.display_title string or null

          Title to be displayed on the online retailer's site or service

        • components.release.translations.cline_license string or null
        • components.release.translations.cline_owner string or null
        • components.release.translations.display_label string or null

          Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

        • components.release.translations.internal_synopsis string or null

          Summary information meant for internal use. This data is not passed to downstream systems or partners.

        • components.release.translations.notes string or null

          Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

        • components.release.translations.pline_license string or null
        • components.release.translations.pline_owner string or null
        • components.release.translations.series string or null
        • components.release.translations.title string or null
        • components.release.translations.version string or null

          Used to distinguish multiple versions of the same record. (Example: 'Live')

        • components.release.translations.version_display_title string or null

          Version to be displayed on the online retailer's site or service. (Example: 'Live')

        • components.release.translations.video_long_description string or null
        • components.release.translations.video_network string or null
        • components.release.translations.video_production_company string or null

          The company that produced this release

        • components.release.translations.video_rating_reason string or null
        • components.release.translations.video_short_description string or null
      • components.release.discs array of discs objects

        Discs associate tracks (via disc_tracks) to releases. A release may have 1 or more discs, and those discs may have 1 or more tracks (via disc_tracks).

        • components.release.discs.id integer or null

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.discs.number integer or null
        • components.release.discs.upc string or null

          Individual discs on multi-disc releases may sometimes have separate UPCs. They may be internal tracking UPCs rather than registered product UPCs.

        • components.release.discs.disc_tracks array of disc_tracks objects

          disc_tracks associate tracks to release via discs (hence the name disc_tracks). They also hold information about the track-on-the-release such as the track number, whether the track is a hidden track, various rights details, etc...

          • components.release.discs.disc_tracks.id integer or null

            Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

          • components.release.discs.disc_tracks.number integer or null
          • components.release.discs.disc_tracks.side integer or string or null

            The side this track belongs to (for double-sided release configurations). Can be any of A, B, 1, or 2.

          • components.release.discs.disc_tracks.track_id integer
          • components.release.discs.disc_tracks.global_instant_grat_date date
          • components.release.discs.disc_tracks.global_prestream_date date
          • components.release.discs.disc_tracks.territory_rights array of territory_rights objects
            • components.release.discs.disc_tracks.territory_rights.region_id integer or null
            • components.release.discs.disc_tracks.territory_rights.legal boolean
            • components.release.discs.disc_tracks.territory_rights.prestream_date date

              The date this track becomes available to Pre-Stream

            • components.release.discs.disc_tracks.territory_rights.instant_grat_date date

              The date this track becomes available for Instant Grat

            • components.release.discs.disc_tracks.territory_rights.sellable boolean

              If this Track can be sold separately

            • components.release.discs.disc_tracks.territory_rights.download boolean

              If this Track has Permanent Download rights

            • components.release.discs.disc_tracks.territory_rights.streaming boolean

              If this Track has Subscription streaming rights

            • components.release.discs.disc_tracks.territory_rights.ad_supported_streaming boolean

              If this Track has Ad Supported streaming rights

            • components.release.discs.disc_tracks.territory_rights.user_generated_video string or null

              User Generated Video rights

          • components.release.discs.disc_tracks.track Track object
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/packages/6000695/ \ -u {API Key Id}

Response example

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Bundle)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "components": [ { "id": 6000200, "number": 1, "release": { "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Disc 1)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } }, { "id": 6000201, "number": 2, "release": { "id": 6000692, "title": "If That's What It Takes (Disc 2)", "deleted_at": null, "version": null, "pline_year": null, "pline_owner": null, "pline_license": null, "cline_year": null, "cline_owner": null, "cline_license": null, "vline": null, "artist_display_name": null, "genre": null, "sub_genre": null, "metadata_language": null, "audio_language": null, "metadata_language_country": null, "contributions": [], "display_label": null, "release_number": null, "music_type": "pop", "audio_presentation": null, "resolution_type": null, "internal_synopsis": null, "notes": null, "compilation_type": null, "created_at": "2026-06-01T20:16:10Z", "updated_at": "2026-06-01T20:16:10Z", "parental_advisory": "Non-Applicable", "label": { "id": 6000577, "name": "Smooth Records Group" }, "configuration": "eAlbum (audio)", "keywords": null, "upc": null, "translations": [], "studio_name": null, "preorder": false, "earliest_preorder_date": null, "release_date": null, "original_release_date": null, "reissue_date": null, "project": null, "release_price_tier": null, "territory_rights": [], "status": "Draft", "discs": [ { "id": 6000283, "number": 1, "upc": null, "disc_tracks": [] } ] } } ] }

Edit a Package Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/packages/{id}/

Pass existing component IDs (via id) to update or reorder them. Omit the ID to append a new component. Components not included in the request are preserved. Component number values must be consecutive starting from 1.

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • title string
  • configuration string
  • label string
  • display_title string or null
  • version_title string or null

    Used to distinguish multiple versions of the same record. (Example: 'Live')

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • series_name string or null
  • release_date date

    The primary release date associated with this Release

  • release_time time
  • original_release_date date

    The date this Release was originally released if previously released.

  • artist_display_name string or null
  • artist_type string or null
  • name_format string or null
  • upc string or null
  • catalog_number string or null
  • music_type string or null

    Type of Music (May impact available metadata fields)

  • audio_language string or null

    Primary language of recorded audio

  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • compilation_type string or null

    Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

  • cover_art_id integer or null
  • parental_advisory string or null
  • promotional boolean
  • box_set boolean
  • indie_exclusive boolean
  • soundtrack boolean

    If checked, this Release contains audio used for the soundtrack of a Film or Television show

  • audio_presentation string or null

    The format of the associated audio

  • resolution_type string or null
  • studio string or null

    Studio Name for MFiT Releases. Digital configurations only.

  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • internal_synopsis string or null

    Summary information meant for internal use. This data is not passed to downstream systems or partners.

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • distribution_group string or null
  • territory_rights array of territory_rights objects
    • territory_rights.region_id integer
    • territory_rights.legal boolean
    • territory_rights.release_date date

      The primary release date associated with this Release

    • territory_rights.preorder_date date

      Date at which the release becomes available for Pre-Order

    • territory_rights.distribution_territory boolean
    • territory_rights.default_track_territory_rights default_track_territory_rights object
      • territory_rights.default_track_territory_rights.legal boolean
      • territory_rights.default_track_territory_rights.prestream_date date

        The date this track becomes available to Pre-Stream

      • territory_rights.default_track_territory_rights.instant_grat_date date

        The date this track becomes available for Instant Grat

      • territory_rights.default_track_territory_rights.sellable boolean

        If this Track can be sold separately

      • territory_rights.default_track_territory_rights.download boolean

        If this Track has Permanent Download rights

      • territory_rights.default_track_territory_rights.streaming boolean

        If this Track has Subscription streaming rights

      • territory_rights.default_track_territory_rights.ad_supported_streaming boolean

        If this Track has Ad Supported streaming rights

      • territory_rights.default_track_territory_rights.user_generated_video string or null

        User Generated Video rights

  • rights_period string or null
  • rights_expiry_rule string or null
  • lost_rights boolean

    e.g. "The license has expired and you've lost the right to distribute this release"

  • lost_rights_on date
  • lost_rights_reason string or null
  • partner_restrictions string or null
  • distribution_notes string or null
  • license string or null
  • license_start date
  • license_expiration date
  • track_listing_embargo date
  • audio_embargo date
  • cover_art_embargo date
  • product_details_embargo date
  • project_id integer or null
  • partners partners object
    • partners.excluded boolean
    • partners.partner_names array of strings
  • release_price_tier string or null
  • track_price_tier string or null

    Digital configurations only.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • cover_art cover_art object
    • cover_art.title string or null
    • cover_art.resource_number string or null
    • cover_art.parental_advisory string or null

      A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.artist_display_name string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.internal_synopsis string or null

      Summary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.series string or null
    • translations.title string or null
    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.video_long_description string or null
    • translations.video_network string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_rating_reason string or null
    • translations.video_short_description string or null
  • components array of components objects

    Components associate releases with a bundle/package release. Existing releases can be added to a Bundle as components using the release_id parameter or new releases can be created using the release parameter.

    • components.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • components.number integer or null

      The component order number. Component ordering must be sequential

    • components.release_id integer

      ID of associated Release record. Use to associate a Release as a component on a Package Release

    • components.release release object

      The Release object. When creating/editing a Package Release a full representation of a component Release can be passed to create a new Release as a component of the Package

      • components.release.title string
      • components.release.configuration string
      • components.release.label string
      • components.release.display_title string or null
      • components.release.version_title string or null

        Used to distinguish multiple versions of the same record. (Example: 'Live')

      • components.release.version_display_title string or null
      • components.release.display_label string or null

        Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

      • components.release.genre string or null

        genre choice also determines valid sub_genre choices (if available)

      • components.release.sub_genre string or null

        sub_genre choices (if available) are dependent on genre choice.

        See genre for list of valid options.

      • components.release.series_name string or null
      • components.release.release_date date

        The primary release date associated with this Release

      • components.release.release_time time
      • components.release.original_release_date date

        The date this Release was originally released if previously released.

      • components.release.artist_display_name string or null
      • components.release.artist_type string or null
      • components.release.name_format string or null
      • components.release.upc string or null
      • components.release.catalog_number string or null
      • components.release.music_type string or null

        Type of Music (May impact available metadata fields)

      • components.release.audio_language string or null

        Primary language of recorded audio

      • components.release.metadata_language string or null

        Language in which the metadata is written

      • components.release.metadata_language_country string or null

        Country that the Metadata Language is associated with

      • components.release.compilation_type string or null

        Indicates if the Release is a compilation or if the Release contains audio used for the soundtrack of a Film or Television show

      • components.release.cover_art_id integer or null
      • components.release.parental_advisory string or null
      • components.release.promotional boolean
      • components.release.box_set boolean
      • components.release.indie_exclusive boolean
      • components.release.soundtrack boolean

        If checked, this Release contains audio used for the soundtrack of a Film or Television show

      • components.release.audio_presentation string or null

        The format of the associated audio

      • components.release.resolution_type string or null
      • components.release.studio string or null

        Studio Name for MFiT Releases. Digital configurations only.

      • components.release.pline_year integer or null
      • components.release.pline_owner string or null
      • components.release.pline_license string or null
      • components.release.cline_year integer or null
      • components.release.cline_owner string or null
      • components.release.cline_license string or null
      • components.release.vline string or null

        The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

      • components.release.keywords string or null

        Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

      • components.release.internal_synopsis string or null

        Summary information meant for internal use. This data is not passed to downstream systems or partners.

      • components.release.notes string or null

        Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

      • components.release.distribution_group string or null
      • components.release.territory_rights array of territory_rights objects
        • components.release.territory_rights.region_id integer
        • components.release.territory_rights.legal boolean
        • components.release.territory_rights.release_date date

          The primary release date associated with this Release

        • components.release.territory_rights.preorder_date date

          Date at which the release becomes available for Pre-Order

        • components.release.territory_rights.distribution_territory boolean
        • components.release.territory_rights.default_track_territory_rights default_track_territory_rights object
          • components.release.territory_rights.default_track_territory_rights.legal boolean
          • components.release.territory_rights.default_track_territory_rights.prestream_date date

            The date this track becomes available to Pre-Stream

          • components.release.territory_rights.default_track_territory_rights.instant_grat_date date

            The date this track becomes available for Instant Grat

          • components.release.territory_rights.default_track_territory_rights.sellable boolean

            If this Track can be sold separately

          • components.release.territory_rights.default_track_territory_rights.download boolean

            If this Track has Permanent Download rights

          • components.release.territory_rights.default_track_territory_rights.streaming boolean

            If this Track has Subscription streaming rights

          • components.release.territory_rights.default_track_territory_rights.ad_supported_streaming boolean

            If this Track has Ad Supported streaming rights

          • components.release.territory_rights.default_track_territory_rights.user_generated_video string or null

            User Generated Video rights

      • components.release.rights_period string or null
      • components.release.rights_expiry_rule string or null
      • components.release.lost_rights boolean

        e.g. "The license has expired and you've lost the right to distribute this release"

      • components.release.lost_rights_on date
      • components.release.lost_rights_reason string or null
      • components.release.partner_restrictions string or null
      • components.release.distribution_notes string or null
      • components.release.license string or null
      • components.release.license_start date
      • components.release.license_expiration date
      • components.release.track_listing_embargo date
      • components.release.audio_embargo date
      • components.release.cover_art_embargo date
      • components.release.product_details_embargo date
      • components.release.project_id integer or null
      • components.release.partners partners object
        • components.release.partners.excluded boolean
        • components.release.partners.partner_names array of strings
      • components.release.release_price_tier string or null
      • components.release.track_price_tier string or null

        Digital configurations only.

      • components.release.primary_contributions array of primary_contributions objects

        The position of each record is determined by the order of the elements in this array.

        • components.release.primary_contributions.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.primary_contributions.featured boolean
        • components.release.primary_contributions.artist string

          The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

        • components.release.primary_contributions.artist_id integer
      • components.release.contributions array of contributions objects

        The position of each record is determined by the order of the elements in this array.

        • components.release.contributions.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.contributions.role string or null

        • components.release.contributions.type string or null

          More specific Type of Role the artist played. Valid type choice depends on role choice.

          See role for list of valid options.

        • components.release.contributions.artist string

          The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

        • components.release.contributions.artist_id integer
      • components.release.cover_art cover_art object
        • components.release.cover_art.title string or null
        • components.release.cover_art.resource_number string or null
        • components.release.cover_art.parental_advisory string or null

          A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

      • components.release.partner_ids array of partner_ids objects

        Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

        Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

        • components.release.partner_ids.id integer

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.partner_ids.name string

          The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

        • components.release.partner_ids.value string

          The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

      • components.release.translations array of translations objects

        Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

        • components.release.translations.language string

          Exact name of the translation language

          Options
          language
          Haryanvi
          Garhwali
          Achinese
          Acoli
          Adangme
          Adyghe; Adygei
          Afro-Asiatic languages
          Afrihili
          Guadeloupean Creole French
          Ainu
          Chhattisgarhi
          Akkadian
          Jamaican Creole English
          Aleut
          Algonquian languages
          Southern Altai
          Malaccan Creole Portuguese
          English, Old (ca.450-1100)
          Angika
          Apache languages
          Malvi
          Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
          Plautdietsch
          Mapudungun; Mapuche
          Arapaho
          Artificial languages
          Arawak
          Asturian; Bable; Leonese; Asturleonese
          Athapascan languages
          Australian languages
          Awadhi
          Banda languages
          Bamileke languages
          Baluchi
          Balinese
          Basa
          Baltic languages
          Beja; Bedawiyet
          Bemba
          Berber languages
          Bhojpuri
          Bikol
          Bini; Edo
          Siksika
          Braj
          Batak languages
          Buriat
          Buginese
          Blin; Bilin
          Caddo
          Central American Indian languages
          Galibi Carib
          Caucasian languages
          Cebuano
          Celtic languages
          Chibcha
          Chagatai
          Chuukese
          Mari
          Chinook jargon
          Choctaw
          Chipewyan; Dene Suline
          Cherokee
          Cheyenne
          Chamic languages
          Coptic
          Creoles and pidgins, English based
          Crimean Tatar; Crimean Turkish
          Kashubian
          Cushitic languages
          Dakota
          Dargwa
          Land Dayak languages
          Delaware
          Slave (Athapascan)
          Dogrib
          Dinka
          Dogri
          Dravidian languages
          Lower Sorbian
          Duala
          Dutch, Middle (ca.1050-1350)
          Dyula
          Efik
          Egyptian (Ancient)
          Ekajuk
          Elamite
          English, Middle (1100-1500)
          Ewondo
          Fang
          Fanti
          Filipino; Pilipino
          Finno-Ugrian languages
          Fon
          French, Middle (ca.1400-1600)
          French, Old (842-ca.1400)
          Northern Frisian
          Eastern Frisian
          Friulian
          Ga
          Gayo
          Gbaya
          Germanic languages
          Geez
          Gilbertese
          German, Middle High (ca.1050-1500)
          German, Old High (ca.750-1050)
          Gondi
          Gorontalo
          Gothic
          Grebo
          Greek, Ancient (to 1453)
          Swiss German; Alemannic; Alsatian
          Gwich'in
          Haida
          Hawaiian
          Hiligaynon
          Himachali languages; Western Pahari languages
          Hittite
          Hmong; Mong
          Upper Sorbian
          Hupa
          Iban
          Ijo languages
          Iloko
          Indic languages
          Indo-European languages
          Ingush
          Iranian languages
          Iroquoian languages
          Lojban
          Judeo-Persian
          Judeo-Arabic
          Kara-Kalpak
          Kabyle
          Kachin; Jingpho
          Kamba
          Karen languages
          Kawi
          Kabardian
          Khasi
          Khoisan languages
          Khotanese; Sakan
          Kimbundu
          Konkani
          Kosraean
          Kpelle
          Karachay-Balkar
          Karelian
          Kru languages
          Kurukh
          Kumyk
          Kutenai
          Ladino
          Lahnda
          Lamba
          Lezghian
          Mongo
          Lozi
          Luba-Lulua
          Luiseno
          Lunda
          Luo (Kenya and Tanzania)
          Lushai
          Madurese
          Magahi
          Maithili
          Makasar
          Mandingo
          Austronesian languages
          Masai
          Moksha
          Mandar
          Mende
          Irish, Middle (900-1200)
          Mi'kmaq; Micmac
          Minangkabau
          Uncoded languages
          Mon-Khmer languages
          Manchu
          Manipuri
          Manobo languages
          Mohawk
          Mossi
          Multiple languages
          Munda languages
          Creek
          Mirandese
          Marwari
          Mayan languages
          Erzya
          Nahuatl languages
          North American Indian languages
          Neapolitan
          Low German; Low Saxon; German, Low; Saxon, Low
          Nepal Bhasa; Newari
          Nias
          Niger-Kordofanian languages
          Niuean
          Nogai
          Norse, Old
          N'Ko
          Pedi; Sepedi; Northern Sotho
          Nubian languages
          Classical Newari; Old Newari; Classical Nepal Bhasa
          Nyamwezi
          Nyankole
          Nyoro
          Nzima
          Osage
          Turkish, Ottoman (1500-1928)
          Otomian languages
          Papuan languages
          Pangasinan
          Pahlavi
          Pampanga; Kapampangan
          Papiamento
          Palauan
          Persian, Old (ca.600-400 B.C.)
          Philippine languages
          Phoenician
          Pohnpeian
          Prakrit languages
          Provençal, Old (to 1500)
          Reserved for local use
          Rajasthani
          Rapanui
          Rarotongan; Cook Islands Maori
          Romance languages
          Romany
          Aromanian; Arumanian; Macedo-Romanian
          Sandawe
          Yakut
          South American Indian (Other)
          Salishan languages
          Samaritan Aramaic
          Sasak
          Santali
          Sicilian
          Scots
          Selkup
          Semitic languages
          Irish, Old (to 900)
          Sign Languages
          Shan
          Sidamo
          Siouan languages
          Sino-Tibetan languages
          Slavic languages
          Southern Sami
          Sami languages
          Lule Sami
          Inari Sami
          Skolt Sami
          Soninke
          Sogdian
          Songhai languages
          Sranan Tongo
          Serer
          Nilo-Saharan languages
          Sukuma
          Susu
          Sumerian
          Classical Syriac
          Syriac
          Tai languages
          Timne
          Tereno
          Tetum
          Tigre
          Tiv
          Tokelau
          Klingon; tlhIngan-Hol
          Tlingit
          Tamashek
          Tonga (Nyasa)
          Tok Pisin
          Tsimshian
          Tumbuka
          Tupi languages
          Altaic languages
          Tuvalu
          Tuvinian
          Udmurt
          Ugaritic
          Umbundu
          Undetermined
          Vai
          Votic
          Wakashan languages
          Walamo
          Waray
          Washo
          Sorbian languages
          Kalmyk; Oirat
          Yao
          Yapese
          Yupik languages
          Zapotec
          Blissymbols; Blissymbolics; Bliss
          Zenaga
          Standard Moroccan Tamazight
          Zande languages
          Zuni
          No linguistic content; Not applicable
          Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
          Bantu (African language)
          Burushaski
          Mandarin
          Cantonese
          Serbo-Croat
          Afar
          Abkhazian
          Afrikaans
          Akan
          Albanian
          Amharic
          Arabic
          Aragonese
          Armenian
          Assamese
          Avaric
          Avestan
          Aymara
          Azerbaijani
          Bashkir
          Bambara
          Basque
          Belarusian
          Bengali
          Bihari languages
          Bislama
          Bosnian
          Breton (Celtic language)
          Bulgarian
          Burmese
          Catalan; Valencian
          Chamorro
          Chechen
          Chinese
          Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
          Chuvash
          Cornish
          Corsican
          Cree
          Czech
          Danish
          Divehi; Dhivehi; Maldivian
          Dutch; Flemish
          Dzongkha
          English
          Esperanto
          Estonian
          Ewe
          Faroese
          Fijian
          Finnish
          French
          Western Frisian
          Fulah
          Georgian
          German
          Gaelic; Scottish Gaelic
          Irish
          Galician
          Manx
          Greek, Modern (1453-)
          Guarani
          Gujarati
          Haitian; Haitian Creole
          Hausa
          Hebrew
          Herero
          Hindi
          Hiri Motu
          Croatian
          Hungarian
          Igbo
          Icelandic
          Ido
          Sichuan Yi; Nuosu
          Inuktitut
          Interlingue; Occidental
          Interlingua (International Auxiliary Language Association)
          Indonesian
          Inupiaq
          Italian
          Javanese
          Japanese
          Kalaallisut; Greenlandic
          Kannada
          Kashmiri
          Kanuri
          Kazakh
          Central Khmer
          Kikuyu; Gikuyu
          Kinyarwanda
          Kirghiz; Kyrgyz
          Komi
          Kongo
          Korean
          Kuanyama; Kwanyama
          Kurdish
          Lao
          Latin
          Latvian
          Limburgan; Limburger; Limburgish
          Lingala
          Lithuanian
          Luxembourgish; Letzeburgesch
          Luba-Katanga
          Ganda
          Macedonian
          Marshallese
          Malayalam
          Maori
          Marathi
          Malay
          Malagasy
          Maltese
          Mongolian
          Nauru
          Navajo; Navaho
          Ndebele, South; South Ndebele
          Ndebele, North; North Ndebele
          Ndonga
          Nepali
          Norwegian Nynorsk; Nynorsk, Norwegian
          Bokmål, Norwegian; Norwegian Bokmål
          Norwegian
          Chichewa; Chewa; Nyanja
          Occitan (post 1500); Provençal
          Ojibwa
          Oriya
          Oromo
          Ossetian; Ossetic
          Panjabi; Punjabi
          Persian
          Pali
          Polish
          Portuguese
          Pushto; Pashto
          Quechua
          Romansh
          Romanian; Moldavian; Moldovan
          Rundi
          Russian
          Sango
          Sanskrit
          Sinhala; Sinhalese
          Slovak
          Slovenian
          Northern Sami
          Samoan
          Shona
          Sindhi
          Somali
          Sotho, Southern
          Spanish; Castilian
          Sardinian
          Serbian
          Swati
          Sundanese
          Swahili
          Swedish
          Tahitian
          Tamil
          Tatar
          Telugu
          Tajik
          Tagalog
          Thai
          Tibetan
          Tigrinya
          Tonga (Tonga Islands)
          Tswana
          Tsonga
          Turkmen
          Turkish
          Twi
          Uighur; Uyghur
          Ukrainian
          Urdu
          Uzbek
          Venda
          Vietnamese
          Volapük
          Welsh
          Walloon
          Wolof
          Xhosa
          Yiddish
          Yoruba
          Zhuang; Chuang
          Zulu
          Japanese (Yomigana)
          Chinese (Simplified)
          Chinese (Traditional)
          Montenegrin
          Creoles and pidgins, French-based
          Creoles and pidgins, Portuguese-based
          Creoles and pidgins

        • components.release.translations.artist_display_name string or null
        • components.release.translations.display_title string or null

          Title to be displayed on the online retailer's site or service

        • components.release.translations.cline_license string or null
        • components.release.translations.cline_owner string or null
        • components.release.translations.display_label string or null

          Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

        • components.release.translations.internal_synopsis string or null

          Summary information meant for internal use. This data is not passed to downstream systems or partners.

        • components.release.translations.notes string or null

          Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

        • components.release.translations.pline_license string or null
        • components.release.translations.pline_owner string or null
        • components.release.translations.series string or null
        • components.release.translations.title string or null
        • components.release.translations.version string or null

          Used to distinguish multiple versions of the same record. (Example: 'Live')

        • components.release.translations.version_display_title string or null

          Version to be displayed on the online retailer's site or service. (Example: 'Live')

        • components.release.translations.video_long_description string or null
        • components.release.translations.video_network string or null
        • components.release.translations.video_production_company string or null

          The company that produced this release

        • components.release.translations.video_rating_reason string or null
        • components.release.translations.video_short_description string or null
      • components.release.discs array of discs objects

        Discs associate tracks (via disc_tracks) to releases. A release may have 1 or more discs, and those discs may have 1 or more tracks (via disc_tracks).

        • components.release.discs.id integer or null

          Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

        • components.release.discs.number integer or null
        • components.release.discs.upc string or null

          Individual discs on multi-disc releases may sometimes have separate UPCs. They may be internal tracking UPCs rather than registered product UPCs.

        • components.release.discs.disc_tracks array of disc_tracks objects

          disc_tracks associate tracks to release via discs (hence the name disc_tracks). They also hold information about the track-on-the-release such as the track number, whether the track is a hidden track, various rights details, etc...

          • components.release.discs.disc_tracks.id integer or null

            Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

          • components.release.discs.disc_tracks.number integer or null
          • components.release.discs.disc_tracks.side integer or string or null

            The side this track belongs to (for double-sided release configurations). Can be any of A, B, 1, or 2.

          • components.release.discs.disc_tracks.track_id integer
          • components.release.discs.disc_tracks.global_instant_grat_date date
          • components.release.discs.disc_tracks.global_prestream_date date
          • components.release.discs.disc_tracks.territory_rights array of territory_rights objects
            • components.release.discs.disc_tracks.territory_rights.region_id integer or null
            • components.release.discs.disc_tracks.territory_rights.legal boolean
            • components.release.discs.disc_tracks.territory_rights.prestream_date date

              The date this track becomes available to Pre-Stream

            • components.release.discs.disc_tracks.territory_rights.instant_grat_date date

              The date this track becomes available for Instant Grat

            • components.release.discs.disc_tracks.territory_rights.sellable boolean

              If this Track can be sold separately

            • components.release.discs.disc_tracks.territory_rights.download boolean

              If this Track has Permanent Download rights

            • components.release.discs.disc_tracks.territory_rights.streaming boolean

              If this Track has Subscription streaming rights

            • components.release.discs.disc_tracks.territory_rights.ad_supported_streaming boolean

              If this Track has Ad Supported streaming rights

            • components.release.discs.disc_tracks.territory_rights.user_generated_video string or null

              User Generated Video rights

          • components.release.discs.disc_tracks.track Track object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/packages/6000695/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "title": "If That's What It Takes (Bundle)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": null, "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": "Smooth Records Group", "cover_art": { "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }, "display_title": "Michael McDonald New Soul Classics", "version_display_title": "Special Edition", "series_name": "Soul Classics", "release_time": "12:30:00", "promotional": true, "distribution_group": "New Releases", "rights_period": "perpetuity", "partner_restrictions": "Apple & Tower Records", "distribution_notes": "Limited to 300 copies", "license": "Owned", "track_listing_embargo": "1981-11-05", "project_id": 600001, "version_title": "API Version", "metadata_language_country": "US", "catalog_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize" }, "region_id": 1 } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ], "components": [ { "release": { "title": "If That's What It Takes (Disc 1)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": null, "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": "Smooth Records Group", "cover_art": { "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }, "discs": [ { "disc_tracks": [ { "track": { "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": "Ed Sanford", "affiliation": "BMG", "split_percentage": 50.0, "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD" }, { "artist": "Michael McDonald", "affiliation": "BMG", "split_percentage": null, "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment" } ], "publishers": [ { "publisher": "Yacht Times", "rights_administrator": "SESAC", "affiliation": "BMG", "split_percentage": 100.0, "territory": "only", "restrictions": [ "US" ] } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": null, "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "display_title": "Playin' by the Rules Special Edition", "version_display_title": "Special Bonus Edition", "duration": "PT3M48S", "preview_in": "PT43S", "sample_length": "PT30S", "other_recording_locations": [ "FR", "DE" ], "session_performance_type": "Vocal", "session_type": "Studio", "music_type": "pop", "audio_presentation": "Stereo", "version_title": "Bonus Edition", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true }, { "artist": "Ed Sanford", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ], "rights_holders": [ { "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08", "region_id": 1 } ] } ], "upc": "000000000017" } ], "display_title": "Michael McDonald New Soul Classics", "version_display_title": "Special Edition", "series_name": "Soul Classics", "release_time": "12:30:00", "promotional": true, "distribution_group": "New Releases", "rights_period": "perpetuity", "partner_restrictions": "Apple & Tower Records", "distribution_notes": "Limited to 300 copies", "license": "Owned", "track_listing_embargo": "1981-11-05", "project_id": 600001, "version_title": "API Version", "metadata_language_country": "US", "catalog_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize" }, "region_id": 1 } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] } }, { "release_id": 6000101 } ] }

Response example

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Bundle)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "components": [ { "id": 6000200, "number": 1, "release": { "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Disc 1)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } }, { "id": 6000201, "number": 2, "release": { "id": 6000692, "title": "If That's What It Takes (Disc 2)", "deleted_at": null, "version": null, "pline_year": null, "pline_owner": null, "pline_license": null, "cline_year": null, "cline_owner": null, "cline_license": null, "vline": null, "artist_display_name": null, "genre": null, "sub_genre": null, "metadata_language": null, "audio_language": null, "metadata_language_country": null, "contributions": [], "display_label": null, "release_number": null, "music_type": "pop", "audio_presentation": null, "resolution_type": null, "internal_synopsis": null, "notes": null, "compilation_type": null, "created_at": "2026-06-01T20:16:10Z", "updated_at": "2026-06-01T20:16:10Z", "parental_advisory": "Non-Applicable", "label": { "id": 6000577, "name": "Smooth Records Group" }, "configuration": "eAlbum (audio)", "keywords": null, "upc": null, "translations": [], "studio_name": null, "preorder": false, "earliest_preorder_date": null, "release_date": null, "original_release_date": null, "reissue_date": null, "project": null, "release_price_tier": null, "territory_rights": [], "status": "Draft", "discs": [ { "id": 6000283, "number": 1, "upc": null, "disc_tracks": [] } ] } } ] }

Delete a Package Anchor link icon

DELETE https://{subdomain}.openplaymusic.com/connect/v2/packages/{id}/

Soft delete this record. This can be undone using the undelete endpoint. Deleted records do not appear in search by default but can be retrieved by filtering. Attempting to GET a deleted record will return a 410 response unless the include_deleted=true query parameter is passed.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • deleted_reason string or null

    Optional description for why the record was deleted

Response attributes

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_reason string or null

    Optional description for why the record was deleted

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/packages/6000695/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X DELETE \ -d '{"deleted_reason": "Duplicate"}'

Response example

{ "id": 6000695, "deleted_at": "2022-01-11T15:24:23Z", "deleted_reason": "Duplicate" }

Undelete a Package Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/packages/{id}/undelete/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/packages/6000695/undelete/ \ -u {API Key Id} \ -X PUT

Response example

{ "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Bundle)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "components": [ { "id": 6000200, "number": 1, "release": { "id": 6000695, "created_at": "2022-01-11T15:24:23Z", "updated_at": "2022-01-11T15:24:23Z", "deleted_at": null, "title": "If That's What It Takes (Disc 1)", "release_date": "2022-03-11", "original_release_date": "1981-11-13", "display_label": "Smooth Records Group, Inc.", "audio_presentation": "Stereo", "audio_language": "English", "metadata_language": "English", "music_type": "pop", "artist_display_name": "Michael McDonald & Friends", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "vline": "The Regular Collective", "keywords": "soul classics", "internal_synopsis": "Digital bonus for limited edition blue vinyl", "notes": "Also comes with free hat", "translations": [ { "language": "French", "title": "Si c'est ce qu'il faut", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_label": null, "display_title": "Si c'est ce qu'il faut", "internal_synopsis": null, "notes": null, "pline_license": null, "pline_owner": null, "series": null, "version": null, "version_display_title": null, "video_long_description": null, "video_network": null, "video_production_company": null, "video_rating_reason": null, "video_short_description": null } ], "configuration": "Digital Album", "label": { "id": 6000512, "name": "Smooth Records Group" }, "cover_art": { "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }, "discs": [ { "disc_tracks": [ { "track": { "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }, "id": 6000290, "number": 1, "preorder_only": false, "earliest_instant_grat_date": null, "earliest_prestream_date": null, "territory_rights": [ { "legal": true, "sellable": true, "download": true, "streaming": false, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": "1981-11-05", "instant_grat_date": "1981-08-08" } ] } ], "id": 6000645, "number": 1, "upc": "000000000017" } ], "resolution_type": null, "studio_name": null, "preorder": true, "earliest_preorder_date": "1981-11-01", "project": { "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }, "status": "Draft", "version": "API Version", "metadata_language_country": "United States", "release_number": "SRG00001", "upc": "000000000017", "parental_advisory": "Non-Applicable", "primary_contributions": [ { "id": 6000326, "artist": { "id": 6000640, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000643, "artist": { "id": 6000641, "name": "Kenny Loggins" }, "position": 2, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "territory_rights": [ { "legal": true, "release_date": "1982-01-01", "preorder_date": "1981-11-01", "default_track_territory_rights": { "legal": true, "sellable": true, "download": false, "streaming": true, "ad_supported_streaming": true, "user_generated_video": "Monetize", "prestream_date": null, "instant_grat_date": null }, "region": { "id": 756, "name": "United States", "territory_codes": [ "US" ] }, "distribute": true } ], "release_price_tier": "Premium", "track_price_tier": "Budget", "artist_type": "Recording Entity", "name_format": "Compound Artist", "partners": { "excluded": false, "partner_names": [ "Deezer", "Spotify" ] }, "compilation_type": "Single-Artist Compilation", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } }, { "id": 6000201, "number": 2, "release": { "id": 6000692, "title": "If That's What It Takes (Disc 2)", "deleted_at": null, "version": null, "pline_year": null, "pline_owner": null, "pline_license": null, "cline_year": null, "cline_owner": null, "cline_license": null, "vline": null, "artist_display_name": null, "genre": null, "sub_genre": null, "metadata_language": null, "audio_language": null, "metadata_language_country": null, "contributions": [], "display_label": null, "release_number": null, "music_type": "pop", "audio_presentation": null, "resolution_type": null, "internal_synopsis": null, "notes": null, "compilation_type": null, "created_at": "2026-06-01T20:16:10Z", "updated_at": "2026-06-01T20:16:10Z", "parental_advisory": "Non-Applicable", "label": { "id": 6000577, "name": "Smooth Records Group" }, "configuration": "eAlbum (audio)", "keywords": null, "upc": null, "translations": [], "studio_name": null, "preorder": false, "earliest_preorder_date": null, "release_date": null, "original_release_date": null, "reissue_date": null, "project": null, "release_price_tier": null, "territory_rights": [], "status": "Draft", "discs": [ { "id": 6000283, "number": 1, "upc": null, "disc_tracks": [] } ] } } ] }

Tracks Anchor link icon

Tracks hold metadata about each recorded song on a Release. Tracks can be referenced by multiple Releases, and are related to Releases through the discs.disc_tracks array of disc_track objects on Releases. Tracks can also reference recorded audio files and have additional APIs for handling audio uploads.

The Track Object Anchor link icon

Attributes

  • title string
  • track_type string

    The configuration type of this Track

  • label string or null
  • display_title string or null
  • version_title string or null

    Version of Track (Example: Live)

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • isrc string or null

    ISRC associated with this Track

  • parental_advisory string or null

    A flag used to identify if a Track contains explicit material. This will impact any Release that contains this Track. 'Edited' represents the clean version.

  • duration string or null
  • preview_in string
  • sample_length string
  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • audio_language string or null

    Primary language of recorded audio

  • audio_presentation string or null
  • primary_recording_location string or null

    Location where audio was recorded

  • other_recording_locations array of strings

  • recording_end_date_year integer or null

    The year in which the recording of this track was completed

  • session_performance_type string or null

    Type of Performance of the recording

  • session_type string or null

    Type of session of the recorded track. Can be Studio or Live.

  • music_type string or null

    Type of Music (May impact available metadata fields)

  • contains_ai boolean
  • contains_samples boolean
  • contains_samples_notes string or null
  • artist_type string or null
  • name_format string or null
  • artist_display_name string or null
  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • recording_location_detail string or null

    Additional details about the location where this Track was recorded. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • mixing_location_detail string or null

    Additional details about the location where this Track was mixed. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • mastering_location_detail string or null

    Additional details about the location where this Track was mastered. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • tracking_location_detail string or null

    Additional details about the location where this Track was tracked. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • spotify_18_plus boolean

    (Video tracks only)

    Should this content be marked 18+ in Spotify?

  • korean_age_rating string or null

    (Video tracks only)

    Age rating as classified by the Korea Media Rating Board (KMRB)

    Options
    korean_age_rating
    Not Rated
    All
    7
    12
    15
    19
    Restricted Screening

  • video_category string or null

    (Video tracks only)

    Category of the video (Example: 'Interview, Trailer, EPK')

  • video_country_of_origin string or null

    (Video tracks only)

    The country where this video was created

  • subtitled_language string or null

    (Video tracks only)

    The language of the primary subtitle track

  • dubbed_language string or null

    (Video tracks only)

    The language of the primary dubbed audio

  • dubbed_language_country string or null

    (Video tracks only)

    The country from which the primary dubbed audio language originates

  • closed_captions boolean

    (Video tracks only)

    Yes to indicate that the video includes Closed Captions

  • closed_captions_reason string or null

    (Video tracks only)

    If the video does not have Closed Captions indicate the reason why

    Options
    closed_captions_reason
    archival_content
    edited_for_internet
    english_subtitles
    in_us_no_captions
    never_in_us

  • release_year integer or null

    (Video tracks only)

    The year the video was/will be released

  • production_company string or null

    (Video tracks only)

    The company that produced this release

  • video_isan string or null

    (Video tracks only)

    The International Standard Audiovisual Number associated with this video track.

  • video_type string or null

    (Video tracks only)

    Type or characteristic of the video release (must be valid for configuration)

    Options
    video_type
    Concert Film
    DVD
    Episodic
    Feature/Short
    Film
    Video

  • associated_audio_isrc string or null

    (Video tracks only)

    The ISRC belonging to the audio track associated with this video track.

  • track_configuration string or null

    (Video tracks only)

    The configuration type of this video Track.

    Options
    track_configuration
    Video (long program)
    Video (short program)
    Album (video)
    Single (video)
    All Other

  • aspect_ratio string or null

    (Video tracks only)

    The aspect ratio of the video track

    Options
    aspect_ratio
    16:9
    4:3

  • rating string or null

    (Video tracks only)

    The video content rating

    Options
    rating
    G
    PG
    PG-13
    R
    NC-17
    NR
    UR
    TV-G
    TV-PG
    TV-MA
    TV-Y
    TV-Y7
    TV-14

  • video_preview_in string or null

    (Video tracks only)

    Timestamp in ISO8601 format (e.g PT2M30S for (2 minutes, 30 seconds) )

  • video_preview_out string or null

    (Video tracks only)

    Timestamp in ISO8601 format (e.g PT2M30S for (2 minutes, 30 seconds) )

  • frames_in integer or null

    (Video tracks only)

    Number of frames

  • frames_out integer or null

    (Video tracks only)

    Number of frames

  • short_description string or null

    (Video tracks only)

    Title or name (in short) of the Video production (1000 chars max)

  • long_description string or null

    (Video tracks only)

    Title or name (long description) of the Video production (4000 chars max)

  • video_audio_track_language string or null

    (Video tracks only)

    The audio language from the audio track associated with this video track.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • works array of Work objects
  • work_ids array of integers
  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • union_details array of union_details objects

    The position of each record is determined by the order of the elements in this array.

    • union_details.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • union_details.agreement_type string
    • union_details.status string or null
  • rights_holders array of rights_holders objects

    The position of each record is determined by the order of the elements in this array.

    • rights_holders.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • rights_holders.rights_holder_name string
    • rights_holders.rights_holder_type string
    • rights_holders.rights_use_type string or null
    • rights_holders.rights_begin_date date
    • rights_holders.rights_expiration_date date
    • rights_holders.rights_share string or null

      The percentage split

    • rights_holders.territory string or null
    • rights_holders.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.title string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.artist_display_name string or null
    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.hierarchy_title string or null
    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.video_long_description string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_short_description string or null
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • earliest_release_date date or null

    The earliest release date from releases associated with this Track

  • earliest_distributed_release_date date or null

    The earliest release date from distributed releases across all territories

The Track Object

{ "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }

Search Tracks Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/tracks/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[title] string

    Title to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • filters[isrc] string
  • filters[keywords][] string

    Pass an array of Keywords to filter by

  • filters[work_id][] integer

    Pass an array of Work IDs to filter Tracks by their associated Works

  • filters[release_id][] integer

    Pass an array of Release IDs to filter Tracks by their associated Releases

  • filters[artist_id][] integer

    Pass an array of Artist IDs to filter by

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.title string
    • results.isrc string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/ \ -u {API Key Id} \ -G \ -d "q=If+Keep+Forgettin" \ -d "filters[isrc]=USA555555555"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/tracks/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/tracks/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000024, "title": "I Keep Forgettin'", "isrc": "USOPY8255555" } ] }

Create a Track Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/tracks/

The schema for creating a Track optionally also includes most of the records that can be created along with a Track (Works, etc...).

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • title string
  • track_type string

    The configuration type of this Track

  • label string or null
  • display_title string or null
  • version_title string or null

    Version of Track (Example: Live)

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • isrc string or null

    ISRC associated with this Track

  • parental_advisory string or null

    A flag used to identify if a Track contains explicit material. This will impact any Release that contains this Track. 'Edited' represents the clean version.

  • duration string or null
  • preview_in string
  • sample_length string
  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • audio_language string or null

    Primary language of recorded audio

  • audio_presentation string or null
  • primary_recording_location string or null

    Location where audio was recorded

  • other_recording_locations array of strings

  • recording_end_date_year integer or null

    The year in which the recording of this track was completed

  • session_performance_type string or null

    Type of Performance of the recording

  • session_type string or null

    Type of session of the recorded track. Can be Studio or Live.

  • music_type string or null

    Type of Music (May impact available metadata fields)

  • contains_ai boolean
  • contains_samples boolean
  • contains_samples_notes string or null
  • artist_type string or null
  • name_format string or null
  • artist_display_name string or null
  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • recording_location_detail string or null

    Additional details about the location where this Track was recorded. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • mixing_location_detail string or null

    Additional details about the location where this Track was mixed. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • mastering_location_detail string or null

    Additional details about the location where this Track was mastered. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • tracking_location_detail string or null

    Additional details about the location where this Track was tracked. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • spotify_18_plus boolean

    (Video tracks only)

    Should this content be marked 18+ in Spotify?

  • korean_age_rating string or null

    (Video tracks only)

    Age rating as classified by the Korea Media Rating Board (KMRB)

    Options
    korean_age_rating
    Not Rated
    All
    7
    12
    15
    19
    Restricted Screening

  • video_category string or null

    (Video tracks only)

    Category of the video (Example: 'Interview, Trailer, EPK')

  • video_country_of_origin string or null

    (Video tracks only)

    The country where this video was created

  • subtitled_language string or null

    (Video tracks only)

    The language of the primary subtitle track

  • dubbed_language string or null

    (Video tracks only)

    The language of the primary dubbed audio

  • dubbed_language_country string or null

    (Video tracks only)

    The country from which the primary dubbed audio language originates

  • closed_captions boolean

    (Video tracks only)

    Yes to indicate that the video includes Closed Captions

  • closed_captions_reason string or null

    (Video tracks only)

    If the video does not have Closed Captions indicate the reason why

    Options
    closed_captions_reason
    archival_content
    edited_for_internet
    english_subtitles
    in_us_no_captions
    never_in_us

  • release_year integer or null

    (Video tracks only)

    The year the video was/will be released

  • production_company string or null

    (Video tracks only)

    The company that produced this release

  • video_isan string or null

    (Video tracks only)

    The International Standard Audiovisual Number associated with this video track.

  • video_type string or null

    (Video tracks only)

    Type or characteristic of the video release (must be valid for configuration)

    Options
    video_type
    Concert Film
    DVD
    Episodic
    Feature/Short
    Film
    Video

  • associated_audio_isrc string or null

    (Video tracks only)

    The ISRC belonging to the audio track associated with this video track.

  • track_configuration string or null

    (Video tracks only)

    The configuration type of this video Track.

    Options
    track_configuration
    Video (long program)
    Video (short program)
    Album (video)
    Single (video)
    All Other

  • aspect_ratio string or null

    (Video tracks only)

    The aspect ratio of the video track

    Options
    aspect_ratio
    16:9
    4:3

  • rating string or null

    (Video tracks only)

    The video content rating

    Options
    rating
    G
    PG
    PG-13
    R
    NC-17
    NR
    UR
    TV-G
    TV-PG
    TV-MA
    TV-Y
    TV-Y7
    TV-14

  • video_preview_in string or null

    (Video tracks only)

    Timestamp in ISO8601 format (e.g PT2M30S for (2 minutes, 30 seconds) )

  • video_preview_out string or null

    (Video tracks only)

    Timestamp in ISO8601 format (e.g PT2M30S for (2 minutes, 30 seconds) )

  • frames_in integer or null

    (Video tracks only)

    Number of frames

  • frames_out integer or null

    (Video tracks only)

    Number of frames

  • short_description string or null

    (Video tracks only)

    Title or name (in short) of the Video production (1000 chars max)

  • long_description string or null

    (Video tracks only)

    Title or name (long description) of the Video production (4000 chars max)

  • video_audio_track_language string or null

    (Video tracks only)

    The audio language from the audio track associated with this video track.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • works array of Work objects
  • work_ids array of integers
  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • union_details array of union_details objects

    The position of each record is determined by the order of the elements in this array.

    • union_details.agreement_type string
    • union_details.status string or null
  • rights_holders array of rights_holders objects

    The position of each record is determined by the order of the elements in this array.

    • rights_holders.rights_holder_name string
    • rights_holders.rights_holder_type string
    • rights_holders.rights_use_type string or null
    • rights_holders.rights_begin_date date
    • rights_holders.rights_expiration_date date
    • rights_holders.rights_share string or null

      The percentage split

    • rights_holders.territory string or null
    • rights_holders.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.title string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.artist_display_name string or null
    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.hierarchy_title string or null
    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.video_long_description string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_short_description string or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": "Ed Sanford", "affiliation": "BMG", "split_percentage": 50.0, "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD" }, { "artist": "Michael McDonald", "affiliation": "BMG", "split_percentage": null, "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment" } ], "publishers": [ { "publisher": "Yacht Times", "rights_administrator": "SESAC", "affiliation": "BMG", "split_percentage": 100.0, "territory": "only", "restrictions": [ "US" ] } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": null, "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "display_title": "Playin' by the Rules Special Edition", "version_display_title": "Special Bonus Edition", "duration": "PT3M48S", "preview_in": "PT43S", "sample_length": "PT30S", "other_recording_locations": [ "FR", "DE" ], "session_performance_type": "Vocal", "session_type": "Studio", "music_type": "pop", "audio_presentation": "Stereo", "version_title": "Bonus Edition", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true }, { "artist": "Ed Sanford", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ], "rights_holders": [ { "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }

Response example

{ "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }

Get a Track Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/tracks/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Query parameters

  • include_files boolean

    Send include_files=true to have the response include signed, temporary download URLs for all associated files (release cover art, track audio, etc) in the response. By default no file URLs will be included in the response.

  • include_deleted boolean

    Send include_deleted=true to retrieve records that have been deleted. Otherwise attempting to access a deleted record will result in a 410 error response code.

Response attributes

  • title string
  • track_type string

    The configuration type of this Track

  • label string or null
  • display_title string or null
  • version_title string or null

    Version of Track (Example: Live)

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • isrc string or null

    ISRC associated with this Track

  • parental_advisory string or null

    A flag used to identify if a Track contains explicit material. This will impact any Release that contains this Track. 'Edited' represents the clean version.

  • duration string or null
  • preview_in string
  • sample_length string
  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • audio_language string or null

    Primary language of recorded audio

  • audio_presentation string or null
  • primary_recording_location string or null

    Location where audio was recorded

  • other_recording_locations array of strings

  • recording_end_date_year integer or null

    The year in which the recording of this track was completed

  • session_performance_type string or null

    Type of Performance of the recording

  • session_type string or null

    Type of session of the recorded track. Can be Studio or Live.

  • music_type string or null

    Type of Music (May impact available metadata fields)

  • contains_ai boolean
  • contains_samples boolean
  • contains_samples_notes string or null
  • artist_type string or null
  • name_format string or null
  • artist_display_name string or null
  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • recording_location_detail string or null

    Additional details about the location where this Track was recorded. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • mixing_location_detail string or null

    Additional details about the location where this Track was mixed. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • mastering_location_detail string or null

    Additional details about the location where this Track was mastered. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • tracking_location_detail string or null

    Additional details about the location where this Track was tracked. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • spotify_18_plus boolean

    (Video tracks only)

    Should this content be marked 18+ in Spotify?

  • korean_age_rating string or null

    (Video tracks only)

    Age rating as classified by the Korea Media Rating Board (KMRB)

    Options
    korean_age_rating
    Not Rated
    All
    7
    12
    15
    19
    Restricted Screening

  • video_category string or null

    (Video tracks only)

    Category of the video (Example: 'Interview, Trailer, EPK')

  • video_country_of_origin string or null

    (Video tracks only)

    The country where this video was created

  • subtitled_language string or null

    (Video tracks only)

    The language of the primary subtitle track

  • dubbed_language string or null

    (Video tracks only)

    The language of the primary dubbed audio

  • dubbed_language_country string or null

    (Video tracks only)

    The country from which the primary dubbed audio language originates

  • closed_captions boolean

    (Video tracks only)

    Yes to indicate that the video includes Closed Captions

  • closed_captions_reason string or null

    (Video tracks only)

    If the video does not have Closed Captions indicate the reason why

    Options
    closed_captions_reason
    archival_content
    edited_for_internet
    english_subtitles
    in_us_no_captions
    never_in_us

  • release_year integer or null

    (Video tracks only)

    The year the video was/will be released

  • production_company string or null

    (Video tracks only)

    The company that produced this release

  • video_isan string or null

    (Video tracks only)

    The International Standard Audiovisual Number associated with this video track.

  • video_type string or null

    (Video tracks only)

    Type or characteristic of the video release (must be valid for configuration)

    Options
    video_type
    Concert Film
    DVD
    Episodic
    Feature/Short
    Film
    Video

  • associated_audio_isrc string or null

    (Video tracks only)

    The ISRC belonging to the audio track associated with this video track.

  • track_configuration string or null

    (Video tracks only)

    The configuration type of this video Track.

    Options
    track_configuration
    Video (long program)
    Video (short program)
    Album (video)
    Single (video)
    All Other

  • aspect_ratio string or null

    (Video tracks only)

    The aspect ratio of the video track

    Options
    aspect_ratio
    16:9
    4:3

  • rating string or null

    (Video tracks only)

    The video content rating

    Options
    rating
    G
    PG
    PG-13
    R
    NC-17
    NR
    UR
    TV-G
    TV-PG
    TV-MA
    TV-Y
    TV-Y7
    TV-14

  • video_preview_in string or null

    (Video tracks only)

    Timestamp in ISO8601 format (e.g PT2M30S for (2 minutes, 30 seconds) )

  • video_preview_out string or null

    (Video tracks only)

    Timestamp in ISO8601 format (e.g PT2M30S for (2 minutes, 30 seconds) )

  • frames_in integer or null

    (Video tracks only)

    Number of frames

  • frames_out integer or null

    (Video tracks only)

    Number of frames

  • short_description string or null

    (Video tracks only)

    Title or name (in short) of the Video production (1000 chars max)

  • long_description string or null

    (Video tracks only)

    Title or name (long description) of the Video production (4000 chars max)

  • video_audio_track_language string or null

    (Video tracks only)

    The audio language from the audio track associated with this video track.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • works array of Work objects
  • work_ids array of integers
  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • union_details array of union_details objects

    The position of each record is determined by the order of the elements in this array.

    • union_details.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • union_details.agreement_type string
    • union_details.status string or null
  • rights_holders array of rights_holders objects

    The position of each record is determined by the order of the elements in this array.

    • rights_holders.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • rights_holders.rights_holder_name string
    • rights_holders.rights_holder_type string
    • rights_holders.rights_use_type string or null
    • rights_holders.rights_begin_date date
    • rights_holders.rights_expiration_date date
    • rights_holders.rights_share string or null

      The percentage split

    • rights_holders.territory string or null
    • rights_holders.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.title string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.artist_display_name string or null
    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.hierarchy_title string or null
    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.video_long_description string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_short_description string or null
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • earliest_release_date date or null

    The earliest release date from releases associated with this Track

  • earliest_distributed_release_date date or null

    The earliest release date from distributed releases across all territories

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/6000218/ \ -u {API Key Id}

Response example

{ "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }

Edit a Track Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/tracks/{id}/

Similar to Create a Track the Edit a Track JSON schema can optionally include many of the related Track records (e.g. Works). This way the Edit a Track API can be used to both change which records are associated with a Track and to add new records associated to the Track in a single request.

Associated records are not editable via this API however. Any values sent for associated records will always be used to create new records associated with the Track. Editing associated records must be done via the API Edit endpoints for those records.

Changing associations or adding existing associations (for instance associating this Track with an existing Work record, or adding multiple existing works to this Track) is also possible by passing the IDs of the associated records, as described in the JSON schema.

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • title string
  • track_type string

    The configuration type of this Track

  • label string or null
  • display_title string or null
  • version_title string or null

    Version of Track (Example: Live)

  • version_display_title string or null
  • display_label string or null

    Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

  • genre string or null

    genre choice also determines valid sub_genre choices (if available)

  • sub_genre string or null

    sub_genre choices (if available) are dependent on genre choice.

    See genre for list of valid options.

  • isrc string or null

    ISRC associated with this Track

  • parental_advisory string or null

    A flag used to identify if a Track contains explicit material. This will impact any Release that contains this Track. 'Edited' represents the clean version.

  • duration string or null
  • preview_in string
  • sample_length string
  • metadata_language string or null

    Language in which the metadata is written

  • metadata_language_country string or null

    Country that the Metadata Language is associated with

  • audio_language string or null

    Primary language of recorded audio

  • audio_presentation string or null
  • primary_recording_location string or null

    Location where audio was recorded

  • other_recording_locations array of strings

  • recording_end_date_year integer or null

    The year in which the recording of this track was completed

  • session_performance_type string or null

    Type of Performance of the recording

  • session_type string or null

    Type of session of the recorded track. Can be Studio or Live.

  • music_type string or null

    Type of Music (May impact available metadata fields)

  • contains_ai boolean
  • contains_samples boolean
  • contains_samples_notes string or null
  • artist_type string or null
  • name_format string or null
  • artist_display_name string or null
  • pline_year integer or null
  • pline_owner string or null
  • pline_license string or null
  • cline_year integer or null
  • cline_owner string or null
  • cline_license string or null
  • vline string or null

    The Vanity Line is a designation sent to select partners alongside the P & C lines. It is used in specific cases to capture and communicate marketing credit and branding affiliations.

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • notes string or null

    Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

  • recording_location_detail string or null

    Additional details about the location where this Track was recorded. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • mixing_location_detail string or null

    Additional details about the location where this Track was mixed. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • mastering_location_detail string or null

    Additional details about the location where this Track was mastered. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • tracking_location_detail string or null

    Additional details about the location where this Track was tracked. (e.g. studio name and location) Meant for internal use. This data is not passed to downstream systems or partners.

  • spotify_18_plus boolean

    (Video tracks only)

    Should this content be marked 18+ in Spotify?

  • korean_age_rating string or null

    (Video tracks only)

    Age rating as classified by the Korea Media Rating Board (KMRB)

    Options
    korean_age_rating
    Not Rated
    All
    7
    12
    15
    19
    Restricted Screening

  • video_category string or null

    (Video tracks only)

    Category of the video (Example: 'Interview, Trailer, EPK')

  • video_country_of_origin string or null

    (Video tracks only)

    The country where this video was created

  • subtitled_language string or null

    (Video tracks only)

    The language of the primary subtitle track

  • dubbed_language string or null

    (Video tracks only)

    The language of the primary dubbed audio

  • dubbed_language_country string or null

    (Video tracks only)

    The country from which the primary dubbed audio language originates

  • closed_captions boolean

    (Video tracks only)

    Yes to indicate that the video includes Closed Captions

  • closed_captions_reason string or null

    (Video tracks only)

    If the video does not have Closed Captions indicate the reason why

    Options
    closed_captions_reason
    archival_content
    edited_for_internet
    english_subtitles
    in_us_no_captions
    never_in_us

  • release_year integer or null

    (Video tracks only)

    The year the video was/will be released

  • production_company string or null

    (Video tracks only)

    The company that produced this release

  • video_isan string or null

    (Video tracks only)

    The International Standard Audiovisual Number associated with this video track.

  • video_type string or null

    (Video tracks only)

    Type or characteristic of the video release (must be valid for configuration)

    Options
    video_type
    Concert Film
    DVD
    Episodic
    Feature/Short
    Film
    Video

  • associated_audio_isrc string or null

    (Video tracks only)

    The ISRC belonging to the audio track associated with this video track.

  • track_configuration string or null

    (Video tracks only)

    The configuration type of this video Track.

    Options
    track_configuration
    Video (long program)
    Video (short program)
    Album (video)
    Single (video)
    All Other

  • aspect_ratio string or null

    (Video tracks only)

    The aspect ratio of the video track

    Options
    aspect_ratio
    16:9
    4:3

  • rating string or null

    (Video tracks only)

    The video content rating

    Options
    rating
    G
    PG
    PG-13
    R
    NC-17
    NR
    UR
    TV-G
    TV-PG
    TV-MA
    TV-Y
    TV-Y7
    TV-14

  • video_preview_in string or null

    (Video tracks only)

    Timestamp in ISO8601 format (e.g PT2M30S for (2 minutes, 30 seconds) )

  • video_preview_out string or null

    (Video tracks only)

    Timestamp in ISO8601 format (e.g PT2M30S for (2 minutes, 30 seconds) )

  • frames_in integer or null

    (Video tracks only)

    Number of frames

  • frames_out integer or null

    (Video tracks only)

    Number of frames

  • short_description string or null

    (Video tracks only)

    Title or name (in short) of the Video production (1000 chars max)

  • long_description string or null

    (Video tracks only)

    Title or name (long description) of the Video production (4000 chars max)

  • video_audio_track_language string or null

    (Video tracks only)

    The audio language from the audio track associated with this video track.

  • primary_contributions array of primary_contributions objects

    The position of each record is determined by the order of the elements in this array.

    • primary_contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • primary_contributions.featured boolean
    • primary_contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • primary_contributions.artist_id integer
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
  • works array of Work objects
  • work_ids array of integers
  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • union_details array of union_details objects

    The position of each record is determined by the order of the elements in this array.

    • union_details.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • union_details.agreement_type string
    • union_details.status string or null
  • rights_holders array of rights_holders objects

    The position of each record is determined by the order of the elements in this array.

    • rights_holders.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • rights_holders.rights_holder_name string
    • rights_holders.rights_holder_type string
    • rights_holders.rights_use_type string or null
    • rights_holders.rights_begin_date date
    • rights_holders.rights_expiration_date date
    • rights_holders.rights_share string or null

      The percentage split

    • rights_holders.territory string or null
    • rights_holders.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.title string or null
    • translations.display_title string or null

      Title to be displayed on the online retailer's site or service

    • translations.version string or null

      Used to distinguish multiple versions of the same record. (Example: 'Live')

    • translations.version_display_title string or null

      Version to be displayed on the online retailer's site or service. (Example: 'Live')

    • translations.artist_display_name string or null
    • translations.cline_license string or null
    • translations.cline_owner string or null
    • translations.display_label string or null

      Used to market a particular asset on digital partner sites. To be displayed on the online retailer's site or service.

    • translations.hierarchy_title string or null
    • translations.notes string or null

      Supplementary information meant for internal use. This data is not passed to downstream systems or partners.

    • translations.pline_license string or null
    • translations.pline_owner string or null
    • translations.video_long_description string or null
    • translations.video_production_company string or null

      The company that produced this release

    • translations.video_short_description string or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/6000218/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": "Ed Sanford", "affiliation": "BMG", "split_percentage": 50.0, "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD" }, { "artist": "Michael McDonald", "affiliation": "BMG", "split_percentage": null, "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment" } ], "publishers": [ { "publisher": "Yacht Times", "rights_administrator": "SESAC", "affiliation": "BMG", "split_percentage": 100.0, "territory": "only", "restrictions": [ "US" ] } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": null, "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "display_title": "Playin' by the Rules Special Edition", "version_display_title": "Special Bonus Edition", "duration": "PT3M48S", "preview_in": "PT43S", "sample_length": "PT30S", "other_recording_locations": [ "FR", "DE" ], "session_performance_type": "Vocal", "session_type": "Studio", "music_type": "pop", "audio_presentation": "Stereo", "version_title": "Bonus Edition", "primary_contributions": [ { "artist": "Michael McDonald", "featured": false }, { "artist": "Kenny Loggins", "featured": true }, { "artist": "Ed Sanford", "featured": true } ], "contributions": [ { "artist": "Michael McDonald" }, { "artist": "Kenny Loggins" } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ], "rights_holders": [ { "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }

Response example

{ "id": 6000218, "created_at": "2022-02-22T15:08:58Z", "updated_at": "2025-03-15T16:11:13Z", "deleted_at": null, "title": "I Keep Forgettin'", "track_type": "audio", "display_label": "Smooth Records Group, Inc.", "isrc": "USOPM2200001", "audio_language": "English", "metadata_language": "English", "primary_recording_location": "US", "metadata_language_country": "United States", "parental_advisory": "Non-Applicable", "pline_year": 1981, "pline_owner": "Smooth Records Group", "pline_license": "Under License", "cline_year": 1981, "cline_owner": "Smooth Records Group", "cline_license": "Under License", "recording_end_date_year": 1981, "artist_display_name": "Michael McDonald & Friends", "vline": "The Regular Collective", "keywords": "modern r&b classics", "notes": "Hat not included", "contains_samples": true, "contains_samples_notes": "Warren G's Regulate heavily samples Michael McDonald's I Keep Forgettin'", "recording_location_detail": "Santa Monica, CA", "mixing_location_detail": "Los Angeles, CA", "mastering_location_detail": "Venice, CA", "tracking_location_detail": "Malibu, CA", "works": [ { "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] } ], "translations": [ { "language": "French", "title": "Je n'arrête pas d'oublier", "artist_display_name": null, "cline_license": null, "cline_owner": null, "display_title": "Je n'arrête pas d'oublier", "display_label": null, "hierarchy_title": null, "notes": null, "pline_license": null, "pline_owner": null, "version": null, "version_display_title": null, "video_long_description": null, "video_production_company": null, "video_short_description": null } ], "earliest_release_date": "1982-01-01", "earliest_distributed_release_date": null, "audio_presentation": "Stereo", "audio_hook": 43, "audio_sample_length": 30, "duration": 228, "contains_ai": null, "spotify_18_plus": false, "korean_age_rating": null, "video_category": null, "video_country_of_origin": null, "subtitled_language": null, "dubbed_language": null, "dubbed_language_country": null, "production_company": null, "release_year": null, "closed_captions": true, "closed_captions_reason": null, "video_isan": null, "associated_audio_isrc": null, "track_configuration": null, "video_type": null, "season": null, "production_id": null, "video_audio_track_language": null, "rating": null, "network": null, "aspect_ratio": null, "video_preview_in": null, "frames_in": null, "video_preview_out": null, "frames_out": null, "short_description": null, "long_description": null, "label": { "id": 6000512, "name": "Smooth Records Group" }, "version": "Bonus Edition", "primary_contributions": [ { "id": 6000325, "artist": { "id": 6000326, "name": "Michael McDonald" }, "position": 1, "featured": false }, { "id": 6000377, "artist": { "id": 6000328, "name": "Kenny Loggins" }, "position": 2, "featured": true }, { "id": 6000329, "artist": { "id": 6000306, "name": "Ed Sanford" }, "position": 3, "featured": true } ], "contributions": [ { "artist": { "id": 6000000, "name": "Michael McDonald" }, "id": 6000000, "position": 1 }, { "artist": { "id": 6000001, "name": "Kenny Loggins" }, "id": 6000001, "position": 2 } ], "artist_type": "Recording Entity", "name_format": "Compound Artist", "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ], "rights_holders": [ { "id": 6000789, "rights_holder_name": "Smooth Records Group", "rights_holder_type": "Original Owner", "rights_use_type": "All", "rights_share": "51.0", "rights_begin_date": "1999-09-09", "rights_expiration_date": "2010-10-10", "territory": "only", "restrictions": [ "US", "CA" ] } ] }

Delete a Track Anchor link icon

DELETE https://{subdomain}.openplaymusic.com/connect/v2/tracks/{id}/

Soft delete this record. This can be undone using the undelete endpoint. Deleted records do not appear in search by default but can be retrieved by filtering. Attempting to GET a deleted record will return a 410 response unless the include_deleted=true query parameter is passed.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • deleted_reason string or null

    Optional description for why the record was deleted

Response attributes

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_reason string or null

    Optional description for why the record was deleted

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/6000695/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X DELETE \ -d '{"deleted_reason": "Duplicate"}'

Response example

{ "id": 6000695, "deleted_at": "2022-01-11T15:24:23Z", "deleted_reason": "Duplicate" }

Undelete a Track Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/tracks/{id}/undelete/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/5000023/undelete/ \ -u {API Key Id} \ -X PUT

Response example

{ "id": 5000023, "title": "I Keep Forgettin'" }

Upload a Track audio file Anchor link icon

There are two ways to upload audio files for tracks: using your private API credentials or using a pre-signed URL that can be passed to the client. Make sure you read both approaches to see which is best for your use case.

Upload a Track audio file (server-side) Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/{id}/upload/{filename}

This method works like other API endpoints and involves fewer steps, however it requires using your private API credentials. To keep your access secure the file must be uploaded from a secure place (like your computer, or a server you control). This may be fine for use cases like importing data, but for something like a web application it can be prohibitively slow to have to handle large file transfers yourself before sending them to the API.

For web applications or other use cases where slow clients might need to upload large files you might want to use the Upload a Track audio file (client-side) endpoint. The client-side endpoint allows the client to upload the file directly to the API without having to go through your own server first.

Once files are uploaded they will automatically start processing just like when uploaded to the application. Processing errors are not available via the API and must be viewed in the application. To check if the uploaded file has completed processing poll the Download Track audio file endpoint until the files are available.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/6000000/upload/sample.wav -u {API Key Id} \ -X PUT \ -T sample.wav

Upload a Track audio file (client-side) Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/{id}/presigned_url/

With client-side uploads you can securely allow a client (such as a user of your web application) to upload files directly to the OpenPlay Music API without having to first go through your own server. Large file uploads from slow clients can tie up your webservers for the duration the upload, causing your application to perform slowly or run out of open connections and time out. You can avoid these issues by having the client upload directly to the API, but it involves a couple of additional steps to do so securely.

Step 1 - Request a pre-signed upload

First you request a pre-signed upload from the OpenPlay Music API. This requires your private API credentials and so must be done from your server. The response includes a collection of fields that can be rendered into a form in your web application, which your client can then submit to upload a file directly to the OpenPlay Music API.

Step 2 - Render pre-signed upload fields to your client

The fields from the response must be submitted along with the file, in the same order as in the response, for the OpenPlay Music API to accept the upload from the client. To do this they can be rendered as hidden form fields into an HTML form element also containing a file input. The url from the response must be used as the form action.

Step 3 - Client attaches a file and submits the form

Finally the client will attach a file and submit the form. This file will upload directly from the client to the OpenPlay Music API.

Once files are uploaded they will automatically start processing just like when uploaded to the application. Processing errors are not available via the API and must be viewed in the application. To check if the uploaded file has completed processing poll the Download Track audio file endpoint until the files are available.

Step 1 - Request a pre-signed upload

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/6000000/presigned_url/ \ -u {API Key Id}

Step 1 - Pre-signed upload response

{ "url": "https://example.s3.amazonaws.com", "fields": { "key": "example/6000000/7bbf1836-c0ef-48b0-ae95-c1d4f59102da/${filename}", "acl": "private", "success_action_status": "200", "policy": "eyJleHBexample9uIjoiMexampleNC0xOFQexampleowOVoiLexampleaXRpb25exampleJidWNrZexamplebmR5LW9exampleljLXRlcexampleInN0YXJexampleRoIiwiexamplesImluY2example3NyZy9jexamplehcnQvNjexampleC83YmJmexamplejMGVmLTexampleWU5NS1jexample5MTAyZGexampleyJhY2wiexampleYXRlIn0exampleNjZXNzXexamplebl9zdGexampleiIyMDAiexampletYW16LWexamplenRpYWwiexampleBM1pDNjexample0JSTTVHexample0MDQxNyexampleXN0LTEvexamplezNF9yZXexamplen0seyJ4examplehbGdvcmexampleiJBV1M0exampletU0hBMjexampleyJ4LWFtexamplelIjoiMjexampleTdUMjEyexample9XX0=", "x-amz-credential": "AKIAEXAMPLEXXXXXXXXX/20240417/us-east-1/s3/aws4_request", "x-amz-algorithm": "AWS4-HMAC-SHA256", "x-amz-date": "20240417T212809Z", "x-amz-signature": "97828e3exampled3fh47aexample2ce64c9examplef0fdfbdexamplebc72" } }

Step 2 - Render the URL and fields into an HTML form element

Download Track audio file Anchor link icon

Downloadable Track audio URLs can be retrieved either via the GET Track endpoint or an associated Release's GET Release endpoint by passing the include_files=true parameter.

The response will contain a audio_url key that contains the downloadable URL.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/6000000/?include_files=true \ -u {API Key Id}

Response example

{ "id": 5000123, "title": "I Keep Forgettin'", "original_filename": "file.wav", "audio_url": "https://openplay-example.s3.amazonaws.com/srg/assets/047441412039zza1b75bf489df20a147/file.wav?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Get all Tracks* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

Provides an asynchronous bulk API to download all records in a single request. It is much more efficient for syncing an entire catalog than searching and getting individual records.

The bulk API consists of two URLs: a request URL and a status URL. The request URL starts processing the bulk request and then the status URL is used to poll for the processing status. When processing is finished the status response will include a url where the records can be downloaded. The download contains all the records in a single, gzip compressed, JSONL file.

Get all Tracks (request)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

POST https://{subdomain}.openplaymusic.com/connect/v2/tracks/bulk/

The request URL will begin preparing all records for download. If processing is started the request will return immediately with a 202 status code and a response body with null processed_at and url values.

Processing may take some time. Poll for the current status with the status request.

Single request processing at a time Only one bulk API request can be processed at a time. Requesting another bulk API request while one is being processed will respond with a 409 status code and an error message. Once the request is finished processing another bulk request can be made.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/bulk/ -u {API Key Id} \ -X POST

Response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Get all Tracks (status)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

GET https://{subdomain}.openplaymusic.com/connect/v2/tracks/bulk/

The status URL allows polling for the status of a bulk records request, and returns the url to download the records once they are ready.

While processing the status URL will respond with a 202 status code and a response body with null values for the processed_at and url keys.

When processing is finished the status URL will respond with a 200 status code, and include a timestamp for the processed_at key, as well as a url where the prepared records can be downloaded.

Depending on catalog size and usage processing bulk requests may take a while. Polling every few minutes is probably sufficient to be notified reasonably quickly and avoid rate limits.

Request expiration Records from a processed bulk request will be available for download for 72 hours. After 72 hours the status URL will return a 404 status code indicating there is no bulk request available. Expiration time is different than processing time -- while only a single bulk request can be processing at any time, additional bulk requests are allowed prior to expiration.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/bulk/ -u {API Key Id}

Processing response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Completed response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": "2025-04-17T29:31:22Z", "url": "https://openplay-example.s3.amazonaws.com/tmp/a1234f12-a123-4f12-a123-4f12a1234f12/tracks-2025-04-17-293122.jsonl.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Works Anchor link icon

Works hold metadata about the written music associated with a recorded Track. Works may be referenced by multiple Tracks, and a Track may reference multiple Works (as in medleys).

The Work Object Anchor link icon

Attributes

  • title string
  • music_type string

    Type of Music (May impact available metadata fields)

  • iswc string or null

    The International Standard Musical Work Code associated with this Work

  • label_work_code string or null

    A code used internally to uniquely identify the release.

  • copyright_year integer or null
  • contains_ai boolean
  • public_domain boolean
  • language string or null

    Language in which the Work is written

  • agency string or null

    Royalty/licensing agency for this published Work (Example: BMI, ASCAP, Harry Fox).

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • description string or null

    Full description of the Work

  • lyrics string or null
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.affiliation string or null

      The affiliation

    • contributions.split_percentage number or null

      The percentage split

    • contributions.country string or null
    • contributions.territory string or null

      Where the neighboring rights holder owns rights.

      worldwide (owns rights everywhere), worldwide_except (owns rights everywhere except the countries in restrictions), only (owns rights only in the countries in restrictions).

      Options
      territory
      worldwide
      worldwide_except
      only

    • contributions.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • publishers array of publishers objects

    The position of each record is determined by the order of the elements in this array.

    • publishers.publisher string
    • publishers.publisher_id integer
    • publishers.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • publishers.rights_administrator string or null

      The Rights Administrator

    • publishers.affiliation string or null

      The affiliation

    • publishers.split_percentage number or null

      The percentage split

    • publishers.country string or null
    • publishers.territory string or null

      Where the neighboring rights holder owns rights.

      worldwide (owns rights everywhere), worldwide_except (owns rights everywhere except the countries in restrictions), only (owns rights only in the countries in restrictions).

      Options
      territory
      worldwide
      worldwide_except
      only

    • publishers.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.title string or null
    • translations.description string or null
    • translations.agency string or null
    • translations.lyrics string or null
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

The Work Object

{ "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] }

Search Works Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/works/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[title] string

    Title to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • filters[iswc] string

    ISWC to filter by

  • filters[keywords][] string

    Pass an array of Keywords to filter by

  • filters[artist_id][] integer

    Pass an array of Artist IDs to filter by

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.title string
    • results.iswc string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/works/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/works/ \ -u {API Key Id} \ -G \ -d "q=If+Keep+Forgettin" \ -d "filters[iswc]=T3452468001"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/works/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/works/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000025, "title": "I Keep Forgettin'", "iswc": "T-345246800-1" } ] }

Create a Work Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/works/

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • title string
  • music_type string

    Type of Music (May impact available metadata fields)

  • iswc string or null

    The International Standard Musical Work Code associated with this Work

  • label_work_code string or null

    A code used internally to uniquely identify the release.

  • copyright_year integer or null
  • contains_ai boolean
  • public_domain boolean
  • language string or null

    Language in which the Work is written

  • agency string or null

    Royalty/licensing agency for this published Work (Example: BMI, ASCAP, Harry Fox).

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • description string or null

    Full description of the Work

  • lyrics string or null
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.affiliation string or null

      The affiliation

    • contributions.split_percentage number or null

      The percentage split

    • contributions.country string or null
    • contributions.territory string or null

      Where the neighboring rights holder owns rights.

      worldwide (owns rights everywhere), worldwide_except (owns rights everywhere except the countries in restrictions), only (owns rights only in the countries in restrictions).

      Options
      territory
      worldwide
      worldwide_except
      only

    • contributions.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • publishers array of publishers objects

    The position of each record is determined by the order of the elements in this array.

    • publishers.publisher string
    • publishers.publisher_id integer
    • publishers.rights_administrator string or null

      The Rights Administrator

    • publishers.affiliation string or null

      The affiliation

    • publishers.split_percentage number or null

      The percentage split

    • publishers.country string or null
    • publishers.territory string or null

      Where the neighboring rights holder owns rights.

      worldwide (owns rights everywhere), worldwide_except (owns rights everywhere except the countries in restrictions), only (owns rights only in the countries in restrictions).

      Options
      territory
      worldwide
      worldwide_except
      only

    • publishers.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.title string or null
    • translations.description string or null
    • translations.agency string or null
    • translations.lyrics string or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/works/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": "Ed Sanford", "affiliation": "BMG", "split_percentage": 50.0, "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD" }, { "artist": "Michael McDonald", "affiliation": "BMG", "split_percentage": null, "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment" } ], "publishers": [ { "publisher": "Yacht Times", "rights_administrator": "SESAC", "affiliation": "BMG", "split_percentage": 100.0, "territory": "only", "restrictions": [ "US" ] } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] }

Response example

{ "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] }

Get a Work Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/works/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Query parameters

  • include_deleted boolean

    Send include_deleted=true to retrieve records that have been deleted. Otherwise attempting to access a deleted record will result in a 410 error response code.

Response attributes

  • title string
  • music_type string

    Type of Music (May impact available metadata fields)

  • iswc string or null

    The International Standard Musical Work Code associated with this Work

  • label_work_code string or null

    A code used internally to uniquely identify the release.

  • copyright_year integer or null
  • contains_ai boolean
  • public_domain boolean
  • language string or null

    Language in which the Work is written

  • agency string or null

    Royalty/licensing agency for this published Work (Example: BMI, ASCAP, Harry Fox).

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • description string or null

    Full description of the Work

  • lyrics string or null
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.affiliation string or null

      The affiliation

    • contributions.split_percentage number or null

      The percentage split

    • contributions.country string or null
    • contributions.territory string or null

      Where the neighboring rights holder owns rights.

      worldwide (owns rights everywhere), worldwide_except (owns rights everywhere except the countries in restrictions), only (owns rights only in the countries in restrictions).

      Options
      territory
      worldwide
      worldwide_except
      only

    • contributions.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • publishers array of publishers objects

    The position of each record is determined by the order of the elements in this array.

    • publishers.publisher string
    • publishers.publisher_id integer
    • publishers.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • publishers.rights_administrator string or null

      The Rights Administrator

    • publishers.affiliation string or null

      The affiliation

    • publishers.split_percentage number or null

      The percentage split

    • publishers.country string or null
    • publishers.territory string or null

      Where the neighboring rights holder owns rights.

      worldwide (owns rights everywhere), worldwide_except (owns rights everywhere except the countries in restrictions), only (owns rights only in the countries in restrictions).

      Options
      territory
      worldwide
      worldwide_except
      only

    • publishers.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.title string or null
    • translations.description string or null
    • translations.agency string or null
    • translations.lyrics string or null
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/works/6000672/ \ -u {API Key Id}

Response example

{ "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] }

Edit a Work Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/works/{id}/

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • title string
  • music_type string

    Type of Music (May impact available metadata fields)

  • iswc string or null

    The International Standard Musical Work Code associated with this Work

  • label_work_code string or null

    A code used internally to uniquely identify the release.

  • copyright_year integer or null
  • contains_ai boolean
  • public_domain boolean
  • language string or null

    Language in which the Work is written

  • agency string or null

    Royalty/licensing agency for this published Work (Example: BMI, ASCAP, Harry Fox).

  • keywords string or null

    Additional keywords to find this content by. Separate keywords with space. Use - or _ for compound words (i.e. 'funky-soul')

  • description string or null

    Full description of the Work

  • lyrics string or null
  • contributions array of contributions objects

    The position of each record is determined by the order of the elements in this array.

    • contributions.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • contributions.artist string

      The primary artist associated with this record. Must exactly match the name of an existing Artist or a new one will be created.

    • contributions.artist_id integer
    • contributions.role string or null

    • contributions.type string or null

      More specific Type of Role the artist played. Valid type choice depends on role choice.

      See role for list of valid options.

    • contributions.affiliation string or null

      The affiliation

    • contributions.split_percentage number or null

      The percentage split

    • contributions.country string or null
    • contributions.territory string or null

      Where the neighboring rights holder owns rights.

      worldwide (owns rights everywhere), worldwide_except (owns rights everywhere except the countries in restrictions), only (owns rights only in the countries in restrictions).

      Options
      territory
      worldwide
      worldwide_except
      only

    • contributions.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • publishers array of publishers objects

    The position of each record is determined by the order of the elements in this array.

    • publishers.publisher string
    • publishers.publisher_id integer
    • publishers.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • publishers.rights_administrator string or null

      The Rights Administrator

    • publishers.affiliation string or null

      The affiliation

    • publishers.split_percentage number or null

      The percentage split

    • publishers.country string or null
    • publishers.territory string or null

      Where the neighboring rights holder owns rights.

      worldwide (owns rights everywhere), worldwide_except (owns rights everywhere except the countries in restrictions), only (owns rights only in the countries in restrictions).

      Options
      territory
      worldwide
      worldwide_except
      only

    • publishers.restrictions array of strings

      The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

  • partner_ids array of partner_ids objects

    Partner IDs are Release/Track/Work identifier codes in external systems. For example an Amazon Product ID. Partner IDs allow you to cross-reference your catalog with other systems.

    Pass the :id parameter to edit an existing Partner ID value or exclude the :id parameter to create a new value.

    • partner_ids.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • partner_ids.name string

      The Name of the Partner ID. Partner IDs can be found on the Details tab of each Release/Track/Work.

    • partner_ids.value string

      The value of the Partner ID. Usually this is a reference to the Release/Track/Work in an external system.

  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.title string or null
    • translations.description string or null
    • translations.agency string or null
    • translations.lyrics string or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/works/6000672/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": "Ed Sanford", "affiliation": "BMG", "split_percentage": 50.0, "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD" }, { "artist": "Michael McDonald", "affiliation": "BMG", "split_percentage": null, "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment" } ], "publishers": [ { "publisher": "Yacht Times", "rights_administrator": "SESAC", "affiliation": "BMG", "split_percentage": 100.0, "territory": "only", "restrictions": [ "US" ] } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001" } ] }

Response example

{ "id": 6000672, "created_at": "2022-02-14T01:44:06Z", "updated_at": "2022-02-14T01:44:06Z", "deleted_at": null, "title": "I Keep Forgettin'", "iswc": "T-345246800-1", "language": "English", "label_work_code": "WORKS123", "music_type": "pop", "agency": "McDonald Publishing", "keywords": "pop soul hits", "contains_ai": false, "public_domain": false, "lyrics": "I keep forgettin' we're not in love anymore\nI keep forgettin' things will never be the same again\nI keep forgettin' how you made that so clear\nI keep forgettin'\n", "copyright_year": 1982, "description": "Written by Michael McDonald and Ed Sanford, this is one of 7 acts in the Playin' by the Rules suite.", "contributions": [ { "artist": { "id": 6000000, "name": "Ed Sanford" }, "affiliation": "BMG", "territory": "worldwide", "restrictions": [], "role": "Author", "type": "DVD", "id": 6000000, "position": 1, "country": "All", "split_percent": 50.0 }, { "artist": { "id": 6000001, "name": "Michael McDonald" }, "affiliation": "BMG", "territory": "worldwide_except", "restrictions": [ "FR" ], "role": "Author", "type": "Accompaniment", "id": 6000001, "position": 2, "country": "Worldwide excluding France", "split_percent": null } ], "publishers": [ { "publisher": { "id": 6000000, "name": "Yacht Times" }, "rights_administrator": "SESAC", "affiliation": "BMG", "territory": "only", "restrictions": [ "US" ], "id": 6000000, "position": 1, "country": "United States", "split_percent": 100.0 } ], "translations": [ { "language": "French", "title": "J'oublie sans cesse", "description": "une chanson douce", "agency": "agence michael mcdonald", "lyrics": "J'oublie sans cesse que nous ne sommes plus amoureux" } ], "partner_ids": [ { "name": "Amazon Product Code", "value": "AMZ001", "id": 6000486 } ] }

Delete a Work Anchor link icon

DELETE https://{subdomain}.openplaymusic.com/connect/v2/works/{id}/

Soft delete this record. This can be undone using the undelete endpoint. Deleted records do not appear in search by default but can be retrieved by filtering. Attempting to GET a deleted record will return a 410 response unless the include_deleted=true query parameter is passed.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • deleted_reason string or null

    Optional description for why the record was deleted

Response attributes

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_reason string or null

    Optional description for why the record was deleted

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/works/6000695/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X DELETE \ -d '{"deleted_reason": "Duplicate"}'

Response example

{ "id": 6000695, "deleted_at": "2022-01-11T15:24:23Z", "deleted_reason": "Duplicate" }

Undelete a Work Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/works/{id}/undelete/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/works/5000023/undelete/ \ -u {API Key Id} \ -X PUT

Response example

{ "id": 5000023, "title": "I Keep Forgettin'" }

Get all Works* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

Provides an asynchronous bulk API to download all records in a single request. It is much more efficient for syncing an entire catalog than searching and getting individual records.

The bulk API consists of two URLs: a request URL and a status URL. The request URL starts processing the bulk request and then the status URL is used to poll for the processing status. When processing is finished the status response will include a url where the records can be downloaded. The download contains all the records in a single, gzip compressed, JSONL file.

Get all Works (request)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

POST https://{subdomain}.openplaymusic.com/connect/v2/works/bulk/

The request URL will begin preparing all records for download. If processing is started the request will return immediately with a 202 status code and a response body with null processed_at and url values.

Processing may take some time. Poll for the current status with the status request.

Single request processing at a time Only one bulk API request can be processed at a time. Requesting another bulk API request while one is being processed will respond with a 409 status code and an error message. Once the request is finished processing another bulk request can be made.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/works/bulk/ -u {API Key Id} \ -X POST

Response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Get all Works (status)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

GET https://{subdomain}.openplaymusic.com/connect/v2/works/bulk/

The status URL allows polling for the status of a bulk records request, and returns the url to download the records once they are ready.

While processing the status URL will respond with a 202 status code and a response body with null values for the processed_at and url keys.

When processing is finished the status URL will respond with a 200 status code, and include a timestamp for the processed_at key, as well as a url where the prepared records can be downloaded.

Depending on catalog size and usage processing bulk requests may take a while. Polling every few minutes is probably sufficient to be notified reasonably quickly and avoid rate limits.

Request expiration Records from a processed bulk request will be available for download for 72 hours. After 72 hours the status URL will return a 404 status code indicating there is no bulk request available. Expiration time is different than processing time -- while only a single bulk request can be processing at any time, additional bulk requests are allowed prior to expiration.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/works/bulk/ -u {API Key Id}

Processing response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Completed response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": "2025-04-17T29:31:22Z", "url": "https://openplay-example.s3.amazonaws.com/tmp/a1234f12-a123-4f12-a123-4f12a1234f12/works-2025-04-17-293122.jsonl.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Artists Anchor link icon

The Artist Object Anchor link icon

Attributes

  • name string

    The name of the artist or group.

  • aka string or null
  • bio string or null
  • email string or null
  • usa_license_indicator string or null
  • rights_controlled boolean
  • ipi_base_number string or null

    IPI (formerly known as CAE) is a unique identifier for persons and entities involved in music publishing.

  • ipi_name_numbers array of strings
  • performing_rights_organizations array of strings
  • facebook_account facebook_account object
    • facebook_account.facebook_id string
  • x_account x_account object
    • x_account.x_id string
  • youtube_account youtube_account object
    • youtube_account.channel_id string
  • instagram_account instagram_account object
    • instagram_account.instagram_id string
  • spotify_account spotify_account object
    • spotify_account.spotify_id string
  • apple_account apple_account object
    • apple_account.apple_id string
  • melon_account melon_account object
    • melon_account.melon_id string
  • youtube_music_account youtube_music_account object
    • youtube_music_account.channel_id string
  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.name string or null
    • translations.bio string or null
    • translations.aka string or null
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

The Artist Object

{ "id": 6000700, "created_at": "2022-01-23T15:18:39Z", "updated_at": "2022-01-23T15:18:39Z", "deleted_at": null, "apple_url": null, "facebook_url": null, "instagram_url": null, "spotify_url": null, "x_url": null, "youtube_url": null, "melon_url": null, "youtube_music_url": null, "apple_account": null, "facebook_account": null, "instagram_account": null, "spotify_account": null, "x_account": null, "youtube_account": null, "melon_account": null, "youtube_music_account": null, "name": "Michael McDonald", "aka": "Mike McDonald", "bio": "Michael McDonald is an American singer-songwriter.", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "translations": [ { "language": "French", "name": "Michel McDonald", "bio": null, "aka": null } ] }

Search Artists Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/artists/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[name] string

    Name to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.name string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/ \ -u {API Key Id} \ -G \ -d "filters[name]=michael+mcdonald"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/artists/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/artists/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000026, "name": "Michael McDonald" } ] }

Create an Artist Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/artists/

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • name string

    The name of the artist or group.

  • aka string or null
  • bio string or null
  • email string or null
  • usa_license_indicator string or null
  • rights_controlled boolean
  • ipi_base_number string or null

    IPI (formerly known as CAE) is a unique identifier for persons and entities involved in music publishing.

  • ipi_name_numbers array of strings
  • performing_rights_organizations array of strings
  • facebook_account facebook_account object
    • facebook_account.facebook_id string
  • x_account x_account object
    • x_account.x_id string
  • youtube_account youtube_account object
    • youtube_account.channel_id string
  • instagram_account instagram_account object
    • instagram_account.instagram_id string
  • spotify_account spotify_account object
    • spotify_account.spotify_id string
  • apple_account apple_account object
    • apple_account.apple_id string
  • melon_account melon_account object
    • melon_account.melon_id string
  • youtube_music_account youtube_music_account object
    • youtube_music_account.channel_id string
  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.name string or null
    • translations.bio string or null
    • translations.aka string or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "name": "Michael McDonald", "aka": "Mike McDonald", "bio": "Michael McDonald is an American singer-songwriter.", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "translations": [ { "language": "French", "name": "Michel McDonald", "bio": null, "aka": null } ] }

Response example

{ "id": 6000700, "created_at": "2022-01-23T15:18:39Z", "updated_at": "2022-01-23T15:18:39Z", "deleted_at": null, "apple_url": null, "facebook_url": null, "instagram_url": null, "spotify_url": null, "x_url": null, "youtube_url": null, "melon_url": null, "youtube_music_url": null, "apple_account": null, "facebook_account": null, "instagram_account": null, "spotify_account": null, "x_account": null, "youtube_account": null, "melon_account": null, "youtube_music_account": null, "name": "Michael McDonald", "aka": "Mike McDonald", "bio": "Michael McDonald is an American singer-songwriter.", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "translations": [ { "language": "French", "name": "Michel McDonald", "bio": null, "aka": null } ] }

Get an Artist Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/artists/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Query parameters

  • include_deleted boolean

    Send include_deleted=true to retrieve records that have been deleted. Otherwise attempting to access a deleted record will result in a 410 error response code.

Response attributes

  • name string

    The name of the artist or group.

  • aka string or null
  • bio string or null
  • email string or null
  • usa_license_indicator string or null
  • rights_controlled boolean
  • ipi_base_number string or null

    IPI (formerly known as CAE) is a unique identifier for persons and entities involved in music publishing.

  • ipi_name_numbers array of strings
  • performing_rights_organizations array of strings
  • facebook_account facebook_account object
    • facebook_account.facebook_id string
  • x_account x_account object
    • x_account.x_id string
  • youtube_account youtube_account object
    • youtube_account.channel_id string
  • instagram_account instagram_account object
    • instagram_account.instagram_id string
  • spotify_account spotify_account object
    • spotify_account.spotify_id string
  • apple_account apple_account object
    • apple_account.apple_id string
  • melon_account melon_account object
    • melon_account.melon_id string
  • youtube_music_account youtube_music_account object
    • youtube_music_account.channel_id string
  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.name string or null
    • translations.bio string or null
    • translations.aka string or null
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/6000700/ \ -u {API Key Id}

Response example

{ "id": 6000700, "created_at": "2022-01-23T15:18:39Z", "updated_at": "2022-01-23T15:18:39Z", "deleted_at": null, "apple_url": null, "facebook_url": null, "instagram_url": null, "spotify_url": null, "x_url": null, "youtube_url": null, "melon_url": null, "youtube_music_url": null, "apple_account": null, "facebook_account": null, "instagram_account": null, "spotify_account": null, "x_account": null, "youtube_account": null, "melon_account": null, "youtube_music_account": null, "name": "Michael McDonald", "aka": "Mike McDonald", "bio": "Michael McDonald is an American singer-songwriter.", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "translations": [ { "language": "French", "name": "Michel McDonald", "bio": null, "aka": null } ] }

Edit an Artist Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/artists/{id}/

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • name string

    The name of the artist or group.

  • aka string or null
  • bio string or null
  • email string or null
  • usa_license_indicator string or null
  • rights_controlled boolean
  • ipi_base_number string or null

    IPI (formerly known as CAE) is a unique identifier for persons and entities involved in music publishing.

  • ipi_name_numbers array of strings
  • performing_rights_organizations array of strings
  • facebook_account facebook_account object
    • facebook_account.facebook_id string
  • x_account x_account object
    • x_account.x_id string
  • youtube_account youtube_account object
    • youtube_account.channel_id string
  • instagram_account instagram_account object
    • instagram_account.instagram_id string
  • spotify_account spotify_account object
    • spotify_account.spotify_id string
  • apple_account apple_account object
    • apple_account.apple_id string
  • melon_account melon_account object
    • melon_account.melon_id string
  • youtube_music_account youtube_music_account object
    • youtube_music_account.channel_id string
  • translations array of translations objects

    Language translations can be provided by specifying the exact name of the language and entering the translated text for each of the related fields.

    • translations.language string

      Exact name of the translation language

      Options
      language
      Haryanvi
      Garhwali
      Achinese
      Acoli
      Adangme
      Adyghe; Adygei
      Afro-Asiatic languages
      Afrihili
      Guadeloupean Creole French
      Ainu
      Chhattisgarhi
      Akkadian
      Jamaican Creole English
      Aleut
      Algonquian languages
      Southern Altai
      Malaccan Creole Portuguese
      English, Old (ca.450-1100)
      Angika
      Apache languages
      Malvi
      Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE)
      Plautdietsch
      Mapudungun; Mapuche
      Arapaho
      Artificial languages
      Arawak
      Asturian; Bable; Leonese; Asturleonese
      Athapascan languages
      Australian languages
      Awadhi
      Banda languages
      Bamileke languages
      Baluchi
      Balinese
      Basa
      Baltic languages
      Beja; Bedawiyet
      Bemba
      Berber languages
      Bhojpuri
      Bikol
      Bini; Edo
      Siksika
      Braj
      Batak languages
      Buriat
      Buginese
      Blin; Bilin
      Caddo
      Central American Indian languages
      Galibi Carib
      Caucasian languages
      Cebuano
      Celtic languages
      Chibcha
      Chagatai
      Chuukese
      Mari
      Chinook jargon
      Choctaw
      Chipewyan; Dene Suline
      Cherokee
      Cheyenne
      Chamic languages
      Coptic
      Creoles and pidgins, English based
      Crimean Tatar; Crimean Turkish
      Kashubian
      Cushitic languages
      Dakota
      Dargwa
      Land Dayak languages
      Delaware
      Slave (Athapascan)
      Dogrib
      Dinka
      Dogri
      Dravidian languages
      Lower Sorbian
      Duala
      Dutch, Middle (ca.1050-1350)
      Dyula
      Efik
      Egyptian (Ancient)
      Ekajuk
      Elamite
      English, Middle (1100-1500)
      Ewondo
      Fang
      Fanti
      Filipino; Pilipino
      Finno-Ugrian languages
      Fon
      French, Middle (ca.1400-1600)
      French, Old (842-ca.1400)
      Northern Frisian
      Eastern Frisian
      Friulian
      Ga
      Gayo
      Gbaya
      Germanic languages
      Geez
      Gilbertese
      German, Middle High (ca.1050-1500)
      German, Old High (ca.750-1050)
      Gondi
      Gorontalo
      Gothic
      Grebo
      Greek, Ancient (to 1453)
      Swiss German; Alemannic; Alsatian
      Gwich'in
      Haida
      Hawaiian
      Hiligaynon
      Himachali languages; Western Pahari languages
      Hittite
      Hmong; Mong
      Upper Sorbian
      Hupa
      Iban
      Ijo languages
      Iloko
      Indic languages
      Indo-European languages
      Ingush
      Iranian languages
      Iroquoian languages
      Lojban
      Judeo-Persian
      Judeo-Arabic
      Kara-Kalpak
      Kabyle
      Kachin; Jingpho
      Kamba
      Karen languages
      Kawi
      Kabardian
      Khasi
      Khoisan languages
      Khotanese; Sakan
      Kimbundu
      Konkani
      Kosraean
      Kpelle
      Karachay-Balkar
      Karelian
      Kru languages
      Kurukh
      Kumyk
      Kutenai
      Ladino
      Lahnda
      Lamba
      Lezghian
      Mongo
      Lozi
      Luba-Lulua
      Luiseno
      Lunda
      Luo (Kenya and Tanzania)
      Lushai
      Madurese
      Magahi
      Maithili
      Makasar
      Mandingo
      Austronesian languages
      Masai
      Moksha
      Mandar
      Mende
      Irish, Middle (900-1200)
      Mi'kmaq; Micmac
      Minangkabau
      Uncoded languages
      Mon-Khmer languages
      Manchu
      Manipuri
      Manobo languages
      Mohawk
      Mossi
      Multiple languages
      Munda languages
      Creek
      Mirandese
      Marwari
      Mayan languages
      Erzya
      Nahuatl languages
      North American Indian languages
      Neapolitan
      Low German; Low Saxon; German, Low; Saxon, Low
      Nepal Bhasa; Newari
      Nias
      Niger-Kordofanian languages
      Niuean
      Nogai
      Norse, Old
      N'Ko
      Pedi; Sepedi; Northern Sotho
      Nubian languages
      Classical Newari; Old Newari; Classical Nepal Bhasa
      Nyamwezi
      Nyankole
      Nyoro
      Nzima
      Osage
      Turkish, Ottoman (1500-1928)
      Otomian languages
      Papuan languages
      Pangasinan
      Pahlavi
      Pampanga; Kapampangan
      Papiamento
      Palauan
      Persian, Old (ca.600-400 B.C.)
      Philippine languages
      Phoenician
      Pohnpeian
      Prakrit languages
      Provençal, Old (to 1500)
      Reserved for local use
      Rajasthani
      Rapanui
      Rarotongan; Cook Islands Maori
      Romance languages
      Romany
      Aromanian; Arumanian; Macedo-Romanian
      Sandawe
      Yakut
      South American Indian (Other)
      Salishan languages
      Samaritan Aramaic
      Sasak
      Santali
      Sicilian
      Scots
      Selkup
      Semitic languages
      Irish, Old (to 900)
      Sign Languages
      Shan
      Sidamo
      Siouan languages
      Sino-Tibetan languages
      Slavic languages
      Southern Sami
      Sami languages
      Lule Sami
      Inari Sami
      Skolt Sami
      Soninke
      Sogdian
      Songhai languages
      Sranan Tongo
      Serer
      Nilo-Saharan languages
      Sukuma
      Susu
      Sumerian
      Classical Syriac
      Syriac
      Tai languages
      Timne
      Tereno
      Tetum
      Tigre
      Tiv
      Tokelau
      Klingon; tlhIngan-Hol
      Tlingit
      Tamashek
      Tonga (Nyasa)
      Tok Pisin
      Tsimshian
      Tumbuka
      Tupi languages
      Altaic languages
      Tuvalu
      Tuvinian
      Udmurt
      Ugaritic
      Umbundu
      Undetermined
      Vai
      Votic
      Wakashan languages
      Walamo
      Waray
      Washo
      Sorbian languages
      Kalmyk; Oirat
      Yao
      Yapese
      Yupik languages
      Zapotec
      Blissymbols; Blissymbolics; Bliss
      Zenaga
      Standard Moroccan Tamazight
      Zande languages
      Zuni
      No linguistic content; Not applicable
      Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki
      Bantu (African language)
      Burushaski
      Mandarin
      Cantonese
      Serbo-Croat
      Afar
      Abkhazian
      Afrikaans
      Akan
      Albanian
      Amharic
      Arabic
      Aragonese
      Armenian
      Assamese
      Avaric
      Avestan
      Aymara
      Azerbaijani
      Bashkir
      Bambara
      Basque
      Belarusian
      Bengali
      Bihari languages
      Bislama
      Bosnian
      Breton (Celtic language)
      Bulgarian
      Burmese
      Catalan; Valencian
      Chamorro
      Chechen
      Chinese
      Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
      Chuvash
      Cornish
      Corsican
      Cree
      Czech
      Danish
      Divehi; Dhivehi; Maldivian
      Dutch; Flemish
      Dzongkha
      English
      Esperanto
      Estonian
      Ewe
      Faroese
      Fijian
      Finnish
      French
      Western Frisian
      Fulah
      Georgian
      German
      Gaelic; Scottish Gaelic
      Irish
      Galician
      Manx
      Greek, Modern (1453-)
      Guarani
      Gujarati
      Haitian; Haitian Creole
      Hausa
      Hebrew
      Herero
      Hindi
      Hiri Motu
      Croatian
      Hungarian
      Igbo
      Icelandic
      Ido
      Sichuan Yi; Nuosu
      Inuktitut
      Interlingue; Occidental
      Interlingua (International Auxiliary Language Association)
      Indonesian
      Inupiaq
      Italian
      Javanese
      Japanese
      Kalaallisut; Greenlandic
      Kannada
      Kashmiri
      Kanuri
      Kazakh
      Central Khmer
      Kikuyu; Gikuyu
      Kinyarwanda
      Kirghiz; Kyrgyz
      Komi
      Kongo
      Korean
      Kuanyama; Kwanyama
      Kurdish
      Lao
      Latin
      Latvian
      Limburgan; Limburger; Limburgish
      Lingala
      Lithuanian
      Luxembourgish; Letzeburgesch
      Luba-Katanga
      Ganda
      Macedonian
      Marshallese
      Malayalam
      Maori
      Marathi
      Malay
      Malagasy
      Maltese
      Mongolian
      Nauru
      Navajo; Navaho
      Ndebele, South; South Ndebele
      Ndebele, North; North Ndebele
      Ndonga
      Nepali
      Norwegian Nynorsk; Nynorsk, Norwegian
      Bokmål, Norwegian; Norwegian Bokmål
      Norwegian
      Chichewa; Chewa; Nyanja
      Occitan (post 1500); Provençal
      Ojibwa
      Oriya
      Oromo
      Ossetian; Ossetic
      Panjabi; Punjabi
      Persian
      Pali
      Polish
      Portuguese
      Pushto; Pashto
      Quechua
      Romansh
      Romanian; Moldavian; Moldovan
      Rundi
      Russian
      Sango
      Sanskrit
      Sinhala; Sinhalese
      Slovak
      Slovenian
      Northern Sami
      Samoan
      Shona
      Sindhi
      Somali
      Sotho, Southern
      Spanish; Castilian
      Sardinian
      Serbian
      Swati
      Sundanese
      Swahili
      Swedish
      Tahitian
      Tamil
      Tatar
      Telugu
      Tajik
      Tagalog
      Thai
      Tibetan
      Tigrinya
      Tonga (Tonga Islands)
      Tswana
      Tsonga
      Turkmen
      Turkish
      Twi
      Uighur; Uyghur
      Ukrainian
      Urdu
      Uzbek
      Venda
      Vietnamese
      Volapük
      Welsh
      Walloon
      Wolof
      Xhosa
      Yiddish
      Yoruba
      Zhuang; Chuang
      Zulu
      Japanese (Yomigana)
      Chinese (Simplified)
      Chinese (Traditional)
      Montenegrin
      Creoles and pidgins, French-based
      Creoles and pidgins, Portuguese-based
      Creoles and pidgins

    • translations.name string or null
    • translations.bio string or null
    • translations.aka string or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/6000700/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "name": "Michael McDonald", "aka": "Mike McDonald", "bio": "Michael McDonald is an American singer-songwriter.", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "translations": [ { "language": "French", "name": "Michel McDonald", "bio": null, "aka": null } ] }

Response example

{ "id": 6000700, "created_at": "2022-01-23T15:18:39Z", "updated_at": "2022-01-23T15:18:39Z", "deleted_at": null, "apple_url": null, "facebook_url": null, "instagram_url": null, "spotify_url": null, "x_url": null, "youtube_url": null, "melon_url": null, "youtube_music_url": null, "apple_account": null, "facebook_account": null, "instagram_account": null, "spotify_account": null, "x_account": null, "youtube_account": null, "melon_account": null, "youtube_music_account": null, "name": "Michael McDonald", "aka": "Mike McDonald", "bio": "Michael McDonald is an American singer-songwriter.", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "translations": [ { "language": "French", "name": "Michel McDonald", "bio": null, "aka": null } ] }

Delete an Artist Anchor link icon

DELETE https://{subdomain}.openplaymusic.com/connect/v2/artists/{id}/

Soft delete this record. This can be undone using the undelete endpoint. Deleted records do not appear in search by default but can be retrieved by filtering. Attempting to GET a deleted record will return a 410 response unless the include_deleted=true query parameter is passed.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • deleted_reason string or null

    Optional description for why the record was deleted

Response attributes

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_reason string or null

    Optional description for why the record was deleted

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/6000695/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X DELETE \ -d '{"deleted_reason": "Duplicate"}'

Response example

{ "id": 6000695, "deleted_at": "2022-01-11T15:24:23Z", "deleted_reason": "Duplicate" }

Undelete an Artist Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/artists/{id}/undelete/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/6000700/undelete/ \ -u {API Key Id} \ -X PUT

Response example

{ "id": 6000700, "name": "Michael McDonald" }

Get all Artists* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

Provides an asynchronous bulk API to download all records in a single request. It is much more efficient for syncing an entire catalog than searching and getting individual records.

The bulk API consists of two URLs: a request URL and a status URL. The request URL starts processing the bulk request and then the status URL is used to poll for the processing status. When processing is finished the status response will include a url where the records can be downloaded. The download contains all the records in a single, gzip compressed, JSONL file.

Get all Artists (request)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

POST https://{subdomain}.openplaymusic.com/connect/v2/artists/bulk/

The request URL will begin preparing all records for download. If processing is started the request will return immediately with a 202 status code and a response body with null processed_at and url values.

Processing may take some time. Poll for the current status with the status request.

Single request processing at a time Only one bulk API request can be processed at a time. Requesting another bulk API request while one is being processed will respond with a 409 status code and an error message. Once the request is finished processing another bulk request can be made.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/bulk/ -u {API Key Id} \ -X POST

Response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Get all Artists (status)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

GET https://{subdomain}.openplaymusic.com/connect/v2/artists/bulk/

The status URL allows polling for the status of a bulk records request, and returns the url to download the records once they are ready.

While processing the status URL will respond with a 202 status code and a response body with null values for the processed_at and url keys.

When processing is finished the status URL will respond with a 200 status code, and include a timestamp for the processed_at key, as well as a url where the prepared records can be downloaded.

Depending on catalog size and usage processing bulk requests may take a while. Polling every few minutes is probably sufficient to be notified reasonably quickly and avoid rate limits.

Request expiration Records from a processed bulk request will be available for download for 72 hours. After 72 hours the status URL will return a 404 status code indicating there is no bulk request available. Expiration time is different than processing time -- while only a single bulk request can be processing at any time, additional bulk requests are allowed prior to expiration.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/artists/bulk/ -u {API Key Id}

Processing response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Completed response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": "2025-04-17T29:31:22Z", "url": "https://openplay-example.s3.amazonaws.com/tmp/a1234f12-a123-4f12-a123-4f12a1234f12/artists-2025-04-17-293122.jsonl.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Publishers Anchor link icon

Publishers hold metadata about publishing companies that can hold rights for published works. Publishers can be attached to works to store rights metadata.

The Publisher Object Anchor link icon

Attributes

  • name string
  • email string or null
  • usa_license_indicator string or null
  • rights_controlled boolean
  • ipi_base_number string or null

    IPI (formerly known as CAE) is a unique identifier for persons and entities involved in music publishing.

  • ipi_name_numbers array of strings
  • performing_rights_organizations array of strings
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

The Publisher Object

{ "id": 6000700, "created_at": "2022-01-28T16:15:03Z", "updated_at": "2022-01-29T16:15:03Z", "name": "M. McDonald's Publishing", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "artists": [], "deleted_at": null }

Search Publishers Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/publishers/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[name] string

    Name to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.name string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/ \ -u {API Key Id} \ -G \ -d "filters[name]=michael+mcdonald+publishing"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/publishers/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/publishers/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000026, "name": "Michael McDonald Publishing" } ] }

Create a Publisher Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/publishers/

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • name string
  • email string or null
  • usa_license_indicator string or null
  • rights_controlled boolean
  • ipi_base_number string or null

    IPI (formerly known as CAE) is a unique identifier for persons and entities involved in music publishing.

  • ipi_name_numbers array of strings
  • performing_rights_organizations array of strings

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "name": "M. McDonald's Publishing", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ] }

Response example

{ "id": 6000700, "created_at": "2022-01-28T16:15:03Z", "updated_at": "2022-01-29T16:15:03Z", "name": "M. McDonald's Publishing", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "artists": [], "deleted_at": null }

Get a Publisher Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/publishers/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

  • name string
  • email string or null
  • usa_license_indicator string or null
  • rights_controlled boolean
  • ipi_base_number string or null

    IPI (formerly known as CAE) is a unique identifier for persons and entities involved in music publishing.

  • ipi_name_numbers array of strings
  • performing_rights_organizations array of strings
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/6000700/ \ -u {API Key Id}

Response example

{ "id": 6000700, "created_at": "2022-01-28T16:15:03Z", "updated_at": "2022-01-29T16:15:03Z", "name": "M. McDonald's Publishing", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "artists": [], "deleted_at": null }

Edit a Publisher Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/publishers/{id}/

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • name string
  • email string or null
  • usa_license_indicator string or null
  • rights_controlled boolean
  • ipi_base_number string or null

    IPI (formerly known as CAE) is a unique identifier for persons and entities involved in music publishing.

  • ipi_name_numbers array of strings
  • performing_rights_organizations array of strings

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/6000700/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "name": "M. McDonald's Publishing", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ] }

Response example

{ "id": 6000700, "created_at": "2022-01-28T16:15:03Z", "updated_at": "2022-01-29T16:15:03Z", "name": "M. McDonald's Publishing", "usa_license_indicator": "ASCAP", "email": "publisher@example.com", "rights_controlled": true, "ipi_base_number": "I-001068130-6", "ipi_name_numbers": [ "00052210040" ], "performing_rights_organizations": [ "ASCAP", "BMI" ], "artists": [], "deleted_at": null }

Delete a Publisher Anchor link icon

DELETE https://{subdomain}.openplaymusic.com/connect/v2/publishers/{id}/

Soft delete this record. This can be undone using the undelete endpoint. Deleted records do not appear in search by default but can be retrieved by filtering. Attempting to GET a deleted record will return a 410 response unless the include_deleted=true query parameter is passed.

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • deleted_reason string or null

    Optional description for why the record was deleted

Response attributes

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_reason string or null

    Optional description for why the record was deleted

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/6000695/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X DELETE \ -d '{"deleted_reason": "Duplicate"}'

Response example

{ "id": 6000695, "deleted_at": "2022-01-11T15:24:23Z", "deleted_reason": "Duplicate" }

Undelete a Publisher Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/publishers/{id}/undelete/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

A successful response will return the Release record JSON object

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/5000026/undelete/ \ -u {API Key Id} \ -X PUT

Response example

{ "id": 5000026, "name": "Michael McDonald Publishing" }

Get all Publishers* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

Provides an asynchronous bulk API to download all records in a single request. It is much more efficient for syncing an entire catalog than searching and getting individual records.

The bulk API consists of two URLs: a request URL and a status URL. The request URL starts processing the bulk request and then the status URL is used to poll for the processing status. When processing is finished the status response will include a url where the records can be downloaded. The download contains all the records in a single, gzip compressed, JSONL file.

Get all Publishers (request)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

POST https://{subdomain}.openplaymusic.com/connect/v2/publishers/bulk/

The request URL will begin preparing all records for download. If processing is started the request will return immediately with a 202 status code and a response body with null processed_at and url values.

Processing may take some time. Poll for the current status with the status request.

Single request processing at a time Only one bulk API request can be processed at a time. Requesting another bulk API request while one is being processed will respond with a 409 status code and an error message. Once the request is finished processing another bulk request can be made.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/bulk/ -u {API Key Id} \ -X POST

Response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Get all Publishers (status)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

GET https://{subdomain}.openplaymusic.com/connect/v2/publishers/bulk/

The status URL allows polling for the status of a bulk records request, and returns the url to download the records once they are ready.

While processing the status URL will respond with a 202 status code and a response body with null values for the processed_at and url keys.

When processing is finished the status URL will respond with a 200 status code, and include a timestamp for the processed_at key, as well as a url where the prepared records can be downloaded.

Depending on catalog size and usage processing bulk requests may take a while. Polling every few minutes is probably sufficient to be notified reasonably quickly and avoid rate limits.

Request expiration Records from a processed bulk request will be available for download for 72 hours. After 72 hours the status URL will return a 404 status code indicating there is no bulk request available. Expiration time is different than processing time -- while only a single bulk request can be processing at any time, additional bulk requests are allowed prior to expiration.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/publishers/bulk/ -u {API Key Id}

Processing response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Completed response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": "2025-04-17T29:31:22Z", "url": "https://openplay-example.s3.amazonaws.com/tmp/a1234f12-a123-4f12-a123-4f12a1234f12/publishers-2025-04-17-293122.jsonl.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Labels Anchor link icon

Search Labels Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/labels/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[name] string

    Name to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.name string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/labels/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/labels/ \ -u {API Key Id} \ -G \ -d "filters[name]=smooth+records+group"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/labels/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/labels/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000026, "name": "Smooth Records Group" } ] }

Create a Label Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/labels/

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • name string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/labels/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "name": "Smooth Records Group" }

Response example

{ "id": 6000700, "created_at": "2022-03-05T00:10:51Z", "updated_at": "2022-03-06T00:10:51Z", "distribution_groups": [], "name": "Smooth Records Group" }

Get a Label Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/labels/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

  • name string
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • id integer or null

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

  • distribution_groups array of distribution_groups objects
    • distribution_groups.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • distribution_groups.name string
    • distribution_groups.active boolean
    • distribution_groups.regions array of regions objects
      • distribution_groups.regions.id integer

        Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

      • distribution_groups.regions.name string
      • distribution_groups.regions.territory_codes array of strings

        The list of countries where the neighboring rights holder does not hold rights (if territory is worldwide_except), or the only countries where rights are held (if territory is only). Ignored if territory is worldwide.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/labels/6000700/ \ -u {API Key Id}

Response example

{ "id": 6000700, "created_at": "2022-03-05T00:10:51Z", "updated_at": "2022-03-06T00:10:51Z", "distribution_groups": [ { "id": 6000800, "name": "New Releases", "active": true, "regions": [ { "id": 6000900, "name": "United States", "territory_codes": [ "US" ] } ] } ], "name": "Smooth Records Group" }

Edit a Label Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/labels/{id}/

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • name string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/labels/6000700/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "name": "Smooth Records Group" }

Response example

{ "id": 6000700, "created_at": "2022-03-05T00:10:51Z", "updated_at": "2022-03-06T00:10:51Z", "distribution_groups": [ { "id": 6000800, "name": "New Releases", "active": true, "regions": [ { "id": 6000900, "name": "United States", "territory_codes": [ "US" ] } ] } ], "name": "Smooth Records Group" }

Cover Art Anchor link icon

Create Cover Art Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/cover_art/

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • title string or null
  • resource_number string or null
  • parental_advisory string or null

    A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/cover_art/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }

Response example

{ "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }

Get Cover Art Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/cover_art/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Query parameters

  • include_files boolean

    Send include_files=true to have the response include signed, temporary download URLs for all associated files (release cover art, track audio, etc) in the response. By default no file URLs will be included in the response.

Response attributes

  • title string or null
  • resource_number string or null
  • parental_advisory string or null

    A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/cover_art/6000000/ \ -u {API Key Id}

Response example

{ "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }

Edit Cover Art Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/cover_art/{id}/

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • title string or null
  • resource_number string or null
  • parental_advisory string or null

    A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/cover_art/6000000/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }

Response example

{ "id": 6000000, "created_at": "2022-02-01T01:53:27Z", "updated_at": "2022-02-02T01:53:27Z", "deleted_at": null, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "Cover Art" }

Upload a Cover Art image file (server-side) Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/cover_art/{id}/upload/{filename}

This method works like other API endpoints and involves fewer steps, however it requires using your private API credentials. To keep your access secure the file must be uploaded from a secure place (like your computer, or a server you control). This may be fine for use cases like importing data, but for something like a web application it can be prohibitively slow to have to handle large file transfers yourself before sending them to the API.

For web applications or other use cases where slow clients might need to upload large files you might want to use the Upload a Cover Art image file (client-side) endpoint. The client-side endpoint allows the client to upload the file directly to the API without having to go through your own server first.

Once files are uploaded they will automatically start processing just like when uploaded to the application. Processing errors are not available via the API and must be viewed in the application. To check if the uploaded file has completed processing poll the Download a Cover Art image file endpoint until the files are available.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/cover_art/6000000/upload/album_cover.tif -u {API Key Id} \ -X PUT \ -T album_cover.tif

Upload a Cover Art image file (client-side) Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/cover_art/{id}/presigned_url/

With client-side uploads you can securely allow a client (such as a user of your web application) to upload files directly to the OpenPlay Music API without having to first go through your own server. Large file uploads from slow clients can tie up your webservers for the duration the upload, causing your application to perform slowly or run out of open connections and time out. You can avoid these issues by having the client upload directly to the API, but it involves a couple of additional steps to do so securely.

Step 1 - Request a pre-signed upload

First you request a pre-signed upload from the OpenPlay Music API. This requires your private API credentials and so must be done from your server. The response includes a collection of fields that can be rendered into a form in your web application, which your client can then submit to upload a file directly to the OpenPlay Music API.

Step 2 - Render pre-signed upload fields to your client

The fields from the response must be submitted along with the file, in the same order as in the response, for the OpenPlay Music API to accept the upload from the client. To do this they can be rendered as hidden form fields into an HTML form element also containing a file input. The url from the response must be used as the form action.

Step 3 - Client attaches a file and submits the form

Finally the client will attach a file and submit the form. This file will upload directly from the client to the OpenPlay Music API.

Once files are uploaded they will automatically start processing just like when uploaded to the application. Processing errors are not available via the API and must be viewed in the application. To check if the uploaded file has completed processing poll the Download a Cover Art image file endpoint until the files are available.

Step 1 - Request a pre-signed upload

curl https://{subdomain}.openplaymusic.com/connect/v2/cover_art/6000000/presigned_url/ \ -u {API Key Id}

Step 1 - Pre-signed upload response

{ "url": "https://example.s3.amazonaws.com", "fields": { "key": "example/6000000/7bbf1836-c0ef-48b0-ae95-c1d4f59102da/${filename}", "acl": "private", "success_action_status": "200", "policy": "eyJleHBexample9uIjoiMexampleNC0xOFQexampleowOVoiLexampleaXRpb25exampleJidWNrZexamplebmR5LW9exampleljLXRlcexampleInN0YXJexampleRoIiwiexamplesImluY2example3NyZy9jexamplehcnQvNjexampleC83YmJmexamplejMGVmLTexampleWU5NS1jexample5MTAyZGexampleyJhY2wiexampleYXRlIn0exampleNjZXNzXexamplebl9zdGexampleiIyMDAiexampletYW16LWexamplenRpYWwiexampleBM1pDNjexample0JSTTVHexample0MDQxNyexampleXN0LTEvexamplezNF9yZXexamplen0seyJ4examplehbGdvcmexampleiJBV1M0exampletU0hBMjexampleyJ4LWFtexamplelIjoiMjexampleTdUMjEyexample9XX0=", "x-amz-credential": "AKIAEXAMPLEXXXXXXXXX/20240417/us-east-1/s3/aws4_request", "x-amz-algorithm": "AWS4-HMAC-SHA256", "x-amz-date": "20240417T212809Z", "x-amz-signature": "97828e3exampled3fh47aexample2ce64c9examplef0fdfbdexamplebc72" } }

Step 2 - Render the URL and fields into an HTML form element

Download a Cover Art image file Anchor link icon

Downloadable Cover Art image URLs can be retrieved either via the GET Cover Art endpoint or an associated Release's GET Release endpoint by passing the include_files=true parameter.

The response will contain a cover_art_url key that contains the downloadable URL.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/cover_art/6000000/?include_files=true \ -u {API Key Id}

Response example

{ "id": 5000023, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "original_filename": "album_cover.tif", "cover_art_url": "https://openplay-example.s3.amazonaws.com/srg/assets/047441412039zza1b75bf489df20a147/album_cover.tif?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Art Resources Anchor link icon

Search Art Resources Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/resources/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[title] string

    Title to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • filters[resource_number] string

    Resource Number to filter by

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.name string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/resources/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/resources/ \ -u {API Key Id} \ -G \ -d "filters[title]=cover+art"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/resources/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/resources/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000023, "title": "If That's What It Takes Cover Art", "resource_number": "24OMGRES00001" } ] }

Get an Art Resource Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/resources/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Query parameters

  • include_files boolean

    Send include_files=true to have the response include signed, temporary download URLs for all associated files (release cover art, track audio, etc) in the response. By default no file URLs will be included in the response.

Response attributes

  • title string or null
  • text string or null
  • resource_number string or null
  • parental_advisory string or null

    A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/resources/6000100/ \ -u {API Key Id}

Response example

{ "id": 6000100, "created_at": "2022-01-22T22:30:36Z", "updated_at": "2022-01-23T22:30:36Z", "deleted_at": null, "title": "If That's What It Takes eBooklet", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "eBooklet" }

Edit an Art Resource Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/resources/{id}/

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • title string or null
  • text string or null
  • resource_number string or null
  • parental_advisory string or null

    A flag used to identify if an Art Resource contains explicit material. This will impact any Release associated with this Art Resource. 'Edited' represents the clean version.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/resources/6000100/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "title": "If That's What It Takes eBooklet", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit" }

Response example

{ "id": 6000100, "created_at": "2022-01-22T22:30:36Z", "updated_at": "2022-01-23T22:30:36Z", "deleted_at": null, "title": "If That's What It Takes eBooklet", "resource_number": "24OMGRES00001", "parental_advisory": "Explicit", "type": "eBooklet" }

Upload an Art Resource file (server-side) Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/resources/{id}/upload/{filename}

This method works like other API endpoints and involves fewer steps, however it requires using your private API credentials. To keep your access secure the file must be uploaded from a secure place (like your computer, or a server you control). This may be fine for use cases like importing data, but for something like a web application it can be prohibitively slow to have to handle large file transfers yourself before sending them to the API.

For web applications or other use cases where slow clients might need to upload large files you might want to use the Upload an Art Resource file (client-side) endpoint. The client-side endpoint allows the client to upload the file directly to the API without having to go through your own server first.

Once files are uploaded they will automatically start processing just like when uploaded to the application. Processing errors are not available via the API and must be viewed in the application. To check if the uploaded file has completed processing poll the Download an Art Resource file endpoint until the files are available.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/resources/6000000/upload/album_art.tif -u {API Key Id} \ -X PUT \ -T album_art.tif

Upload an Art Resource file (client-side) Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/resources/{id}/presigned_url/

With client-side uploads you can securely allow a client (such as a user of your web application) to upload files directly to the OpenPlay Music API without having to first go through your own server. Large file uploads from slow clients can tie up your webservers for the duration the upload, causing your application to perform slowly or run out of open connections and time out. You can avoid these issues by having the client upload directly to the API, but it involves a couple of additional steps to do so securely.

Step 1 - Request a pre-signed upload

First you request a pre-signed upload from the OpenPlay Music API. This requires your private API credentials and so must be done from your server. The response includes a collection of fields that can be rendered into a form in your web application, which your client can then submit to upload a file directly to the OpenPlay Music API.

Step 2 - Render pre-signed upload fields to your client

The fields from the response must be submitted along with the file, in the same order as in the response, for the OpenPlay Music API to accept the upload from the client. To do this they can be rendered as hidden form fields into an HTML form element also containing a file input. The url from the response must be used as the form action.

Step 3 - Client attaches a file and submits the form

Finally the client will attach a file and submit the form. This file will upload directly from the client to the OpenPlay Music API.

Once files are uploaded they will automatically start processing just like when uploaded to the application. Processing errors are not available via the API and must be viewed in the application. To check if the uploaded file has completed processing poll the Download an Art Resource file endpoint until the files are available.

Step 1 - Request a pre-signed upload

curl https://{subdomain}.openplaymusic.com/connect/v2/resources/6000000/presigned_url/ \ -u {API Key Id}

Step 1 - Pre-signed upload response

{ "url": "https://example.s3.amazonaws.com", "fields": { "key": "example/6000000/7bbf1836-c0ef-48b0-ae95-c1d4f59102da/${filename}", "acl": "private", "success_action_status": "200", "policy": "eyJleHBexample9uIjoiMexampleNC0xOFQexampleowOVoiLexampleaXRpb25exampleJidWNrZexamplebmR5LW9exampleljLXRlcexampleInN0YXJexampleRoIiwiexamplesImluY2example3NyZy9jexamplehcnQvNjexampleC83YmJmexamplejMGVmLTexampleWU5NS1jexample5MTAyZGexampleyJhY2wiexampleYXRlIn0exampleNjZXNzXexamplebl9zdGexampleiIyMDAiexampletYW16LWexamplenRpYWwiexampleBM1pDNjexample0JSTTVHexample0MDQxNyexampleXN0LTEvexamplezNF9yZXexamplen0seyJ4examplehbGdvcmexampleiJBV1M0exampletU0hBMjexampleyJ4LWFtexamplelIjoiMjexampleTdUMjEyexample9XX0=", "x-amz-credential": "AKIAEXAMPLEXXXXXXXXX/20240417/us-east-1/s3/aws4_request", "x-amz-algorithm": "AWS4-HMAC-SHA256", "x-amz-date": "20240417T212809Z", "x-amz-signature": "97828e3exampled3fh47aexample2ce64c9examplef0fdfbdexamplebc72" } }

Step 2 - Render the URL and fields into an HTML form element

Download an Art Resource file Anchor link icon

Downloadable Art Resource file URLs can be retrieved either via the GET Art Resource endpoint or an associated Release's GET Release endpoint by passing the include_files=true parameter.

The response will contain a url key that contains the downloadable URL.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/resources/6000000/?include_files=true \ -u {API Key Id}

Response example

{ "id": 6000948, "title": "Cover Art", "original_filename": "album_art.tif", "url": "https://openplay-example.s3.amazonaws.com/srg/assets/047441412039zza1b75bf489df20a147/album_art.tif?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Projects Anchor link icon

Search Projects Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/projects/

Returns paginated results, see documentation for Pagination

Query parameters

  • q string

    The query can contain one or more search keywords. Query string components must be percent-encoded.

  • filters[title] string

    Title to filter by

  • filters[created_at][from] string

    Filter by records created on or after a date in ISO 8601 format (YYYY-MM-DD)

  • filters[created_at][to] string

    Filter by records created on or before a date in ISO 8601 format (YYYY-MM-DD)

  • filters[deleted] string

    Filter records by deleted status. exclude (default) returns only non-deleted records; include returns both deleted and non-deleted; only returns just deleted records.

    Options
    deleted
    exclude
    include
    only

  • filters[project_number] string

    Project Number to filter by

  • filters[artist_id][] integer

    Pass an array of Artist IDs to filter by

  • page integer

    Page number of the results to fetch.

Response attributes

  • next string
  • previous string
  • last string
  • first string
  • current_page integer
  • total_results integer
  • result_range string
  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.title string
    • results.number string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/projects/ \ -u {API Key Id}

Request example with multiple filters

Multiple filters and the q parameter can be combined to narrow down your search.

curl https://{subdomain}.openplaymusic.com/connect/v2/projects/ \ -u {API Key Id} \ -G \ -d "filters[title]=michael+mcdonald+experience"

Response example

{ "next": null, "previous": null, "last": "https://{subdomain}.openplaymusic.com/connect/v2/projects/?page=1", "first": "https://{subdomain}.openplaymusic.com/connect/v2/projects/?page=1", "current_page": 1, "total_results": 1, "result_range": "1 - 1", "results": [ { "id": 5000026, "title": "The Michael McDonald Experience" } ] }

Create a Project Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/v2/projects/

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • title string
  • project_type string

    Type of the Project. Can be "project", or "master_project"

  • project_number string

    The Project Number

  • master_project_id integer or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/projects/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "project_type": "project", "master_project_id": 5000001 }

Response example

{ "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }

Get a Project Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/projects/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Response attributes

  • title string
  • project_type string

    Type of the Project. Can be "project", or "master_project"

  • project_number string

    The Project Number

  • master_project_id integer or null
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/projects/6000000/ \ -u {API Key Id}

Response example

{ "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }

Edit a Project Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/projects/{id}/

Note:

With the sample curl command, the request body would go in a record.json file

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

JSON schema

  • title string
  • project_type string

    Type of the Project. Can be "project", or "master_project"

  • project_number string

    The Project Number

  • master_project_id integer or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/projects/6000000/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -X PUT \ -d@./record.json

./record.json

{ "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "project_type": "project", "master_project_id": 5000001 }

Response example

{ "id": 6000000, "created_at": "2022-02-28T22:35:34Z", "updated_at": "2022-02-29T22:35:34Z", "deleted_at": null, "title": "The Michael McDonald Experience", "project_number": "P-12345-1", "master_project": { "id": 5000001, "title": "Michael McDonald Catalogue", "project_number": "MP-54321-1", "created_at": "2022-02-27T20:21:16Z", "updated_at": "2022-02-28T20:21:16Z", "deleted_at": null } }

Get all Projects* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

Provides an asynchronous bulk API to download all records in a single request. It is much more efficient for syncing an entire catalog than searching and getting individual records.

The bulk API consists of two URLs: a request URL and a status URL. The request URL starts processing the bulk request and then the status URL is used to poll for the processing status. When processing is finished the status response will include a url where the records can be downloaded. The download contains all the records in a single, gzip compressed, JSONL file.

Get all Projects (request)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

POST https://{subdomain}.openplaymusic.com/connect/v2/projects/bulk/

The request URL will begin preparing all records for download. If processing is started the request will return immediately with a 202 status code and a response body with null processed_at and url values.

Processing may take some time. Poll for the current status with the status request.

Single request processing at a time Only one bulk API request can be processed at a time. Requesting another bulk API request while one is being processed will respond with a 409 status code and an error message. Once the request is finished processing another bulk request can be made.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/projects/bulk/ -u {API Key Id} \ -X POST

Response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Get all Projects (status)* Anchor link icon

Additional permission required The bulk APIs require additional permissions, contact support for more information.

GET https://{subdomain}.openplaymusic.com/connect/v2/projects/bulk/

The status URL allows polling for the status of a bulk records request, and returns the url to download the records once they are ready.

While processing the status URL will respond with a 202 status code and a response body with null values for the processed_at and url keys.

When processing is finished the status URL will respond with a 200 status code, and include a timestamp for the processed_at key, as well as a url where the prepared records can be downloaded.

Depending on catalog size and usage processing bulk requests may take a while. Polling every few minutes is probably sufficient to be notified reasonably quickly and avoid rate limits.

Request expiration Records from a processed bulk request will be available for download for 72 hours. After 72 hours the status URL will return a 404 status code indicating there is no bulk request available. Expiration time is different than processing time -- while only a single bulk request can be processing at any time, additional bulk requests are allowed prior to expiration.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/projects/bulk/ -u {API Key Id}

Processing response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": null, "url": null }

Completed response example

{ "created_at": "2025-04-17T22:10:11Z", "processed_at": "2025-04-17T29:31:22Z", "url": "https://openplay-example.s3.amazonaws.com/tmp/a1234f12-a123-4f12-a123-4f12a1234f12/projects-2025-04-17-293122.jsonl.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }

Stems Anchor link icon

Stems are additional audio files related to Tracks.

List Stems Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/tracks/{track_id}/stems/

Response attributes

  • results array of results objects
    • results.id integer

      Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

    • results.title string

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/tracks/{track_id}/stems/ \ -u {API Key Id}

Response example

{ "results": [ { "title": "Vocals", "id": 6001329, "position": 1, "deleted_at": null } ] }

Create a Stem Anchor link icon

POST https://{subdomain}.openplaymusic.com/connect/https://{subdomain}.openplaymusic.com/connect/v2/tracks/{track_id}/stems/

Note:

With the sample curl command, the request body would go in a record.json file

JSON schema

  • title string or null

Request example

curl https://{subdomain}.openplaymusic.com/connect/https://{subdomain}.openplaymusic.com/connect/v2/tracks/{track_id}/stems/ \ -u {API Key Id} \ -H "Content-Type: application/json" \ -d@./record.json

./record.json

{ "title": "Vocals" }

Response example

{ "title": "Vocals", "id": 6001329, "position": 1, "deleted_at": null }

Get a Stem Anchor link icon

GET https://{subdomain}.openplaymusic.com/connect/v2/stems/{id}/

Path parameters

  • id integer

    Unique ID of the record. The ID for each record is returned from the record's Search API, and appears in the browser URL when viewing the record in the application.

Query parameters

  • include_files boolean

    Send include_files=true to have the response include signed, temporary download URLs for all associated files (release cover art, track audio, etc) in the response. By default no file URLs will be included in the response.

Response attributes

  • title string or null
  • created_at string

    The date and time (in UTC) this record was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

  • deleted_at string or null

    The date and time (in UTC) this record was marked as deleted in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/stems/6001329/ \ -u {API Key Id}

Response example

{ "title": "Vocals", "id": 6001329, "position": 1, "deleted_at": null }

Upload Stem Audio (server-side) Anchor link icon

PUT https://{subdomain}.openplaymusic.com/connect/v2/stems/{id}/upload/{filename}

Upload audio files for stems using your private API credentials. To keep your access secure the file must be uploaded from a secure place (like your computer, or a server you control).

Stems are created via the Create a Stem endpoint. Once stems have been created, use this endpoint to upload audio.

Once files are uploaded they will automatically start processing.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/stems/6000214/upload/sample.wav -u {API Key Id} \ -X PUT \ -T sample.wav

Download Stem Audio file Anchor link icon

Downloadable Stem audio URLs can be retrieved either via the GET Stem endpoint or an associated Release's GET Release endpoint by passing the include_files=true parameter.

The response will contain a audio_url key that contains the downloadable URL.

Request example

curl https://{subdomain}.openplaymusic.com/connect/v2/stems/6000000/?include_files=true \ -u {API Key Id}

Response example

{ "id": 6001329, "position": 1, "deleted_at": null, "title": "Vocals", "audio_url": "https://openplay-example.s3.amazonaws.com/srg/assets/047441412039zza1b75bf489df20a147/stem.wav?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXXXXX%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240418T010849Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXXXXX" }