Browsing, Indexes and Lists

Browse folder-style children

Changed on

Return children of a parent object in a folder traversal/browse style. If you don't send any parameters you'll get a catalog list (the 'root' path)

get/browse

Request

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

Query parameters

filterstring
type'root' | 'catalog' | 'album_artist' | 'artist' | 'album' | 'album_disk' | 'podcast'
catalogstring
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

Browse array

total_countinteger required
md5string required
catalog_idstring required
parent_idstring required
parent_typestring required
child_typestring required

Changes

    • info

      added the new enum value album_artist to the query request parameter type

    • info

      added the new enum value album_disk to the query request parameter type

    • info

      api operation id browse 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