Skip to main content
GET
/
background_tracks
List background tracks
curl --request GET \
  --url https://api.beyondwords.io/v1/background_tracks \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "name": "Test track 1",
    "volume": 100,
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": 2,
    "name": "Test track 2",
    "volume": 100,
    "created": "2023-02-01 00:00:00 UTC",
    "updated": "2023-02-01 00:00:05 UTC"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
pagination[limit]
integer

'limit' sets the number of results to return in each page.

​
pagination[offset]
integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

​
filter[scopes]
object

filter items by scopes

​
filter[name]
string
​
filter[custom]
boolean

Response

OK

​
id
integer

Unique identifier for the object

​
name
string

The background track name

​
volume
integer

Percent volume of the track

​
project
object
​
media
object
​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)