v1

latestOpenAPI 3.0.02026-07-131091452.6 MB
audio

List audio licenses

This endpoint lists existing licenses. You can filter the results according to the track ID to see if you have an existing license for a specific track.

get/v2/audio/licenses

Query parameters

audio_idstring

Show licenses for the specified track ID

licensestring

Restrict results by license.

pageinteger

Page number

per_pageinteger

Number of results per page

sort'newest' | 'oldest'

Sort order

usernamestring

Filter licenses by username of licensee

start_datestring date-time

Show licenses created on or after the specified date

end_datestring date-time

Show licenses created before the specified date

download_availability'all' | 'downloadable' | 'non_downloadable'

Filter licenses by download availability

team_historyboolean

Set to true to see license history for all members of your team.

Response

OK

messagestring

Server-generated message, if any

pageinteger

The current page of results

per_pageinteger

The number of results per page

total_countinteger

The total number of results across all pages

Example response

{
  "total_count": 2890,
  "page": 1,
  "per_page": 1,
  "data": [
    {
      "id": "e1eba3833793e77188d22caae8bac9f2cd",
      "user": {
        "username": "editorial_test_account_002"
      },
      "license": "premier_editorial_all_digital",
      "download_time": "2021-07-15T15:46:34.000Z",
      "is_downloadable": false,
      "image": {
        "id": "9763363ao",
        "format": {
          "size": "original"
        }
      },
      "subscription_id": "s12345678",
      "metadata": {
        "purchase_order": "123456",
        "client": "Company A",
        "job": "Important project",
        "other": "Important media"
      }
    }
  ]
}