Browsing, Indexes and Lists

List id/name/prefix/basename (replacement for get_indexes)

Changed on

This takes a named array of objects and returning id, name, prefix and basename

get/list

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/list
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

Query parameters

typestring required
filterstring
hide_search0 | 1
addstring date

Filter to items added on this ISO 8601 date.

updatestring date

Filter to items updated on this ISO 8601 date.

offsetinteger

Return results starting from this index position

limitinteger

Maximum number of results to return

condstring

Apply additional browse filters using ';' separated key,value pairs.

sortstring

Sort key or key,order pair. Example: name or name,ASC.

Response

List response

total_countinteger required
md5string required

Changes

    • info

      api operation id list was added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status