AMampache
Catalogs

Browse children of a catalog (root of the catalog)

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/catalogs/{catalog_id}/browse

Request

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

Path parameters

catalog_idstring required

Unique identifier of the catalog.

Query parameters

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 results

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

Changes

  • e8e6b266ea29Revision changes
    • info

      api operation id browseCatalogs was added

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • b874092765cdRevision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status