API Reference

Pagination

All top-level API resources that have support for "list" calls are paginated. For instance, you can list songs. These list API methods share a common structure, taking two optional query parameters nested under a page key: size and number.

Query Parameters

Query ParameterDefaultDescription
page[size]10The number of results from 1-100 to return.
page[number]1The page to return, one-indexed.

Links Example

List endpoints also return a top-level links object that allows you to easily traverse the list.

{
  ...
  "links": {
    "self": "https://api.soundstripe.com/v1/songs?page%5Bsize%5D=10&page%5Bnumber%5D=1",
    "first": null,
    "prev": null,
    "next": "https://api.soundstripe.com/v1/songs?page%5Bsize%5D=10&page%5Bnumber%5D=2",
    "last": "https://api.soundstripe.com/v1/songs?page%5Bsize%5D=10&page%5Bnumber%5D=800",
    "meta": {
      "total_count": 8000
    }
  }
}