AMampache
Browsing, Indexes and Lists

Index IDs for an object type

Changed on

This takes a collection of inputs and return ID's for the object type. Add 'include' to include child objects

get/index

Request

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

Query parameters

typestring required
filterstring
hide_search0 | 1
exact0 | 1
addstring date

Filter to items added on this ISO 8601 date.

updatestring date

Filter to items updated on this ISO 8601 date.

include0 | 1
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

Index response

IndexResponse required

Keyed by the requested type (e.g. album, artist, song). Without include the value is an array of object ids; with include it is an array of {id, type} references, or a map of parent id -> reference array for parent types such as playlists.

Changes

  • e8e6b266ea29Revision changes
    • breaking

      added subschema #2 subschema #3 to the response property oneOf list for the response status

    • info

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

    • info

      removed subschema #2 subschema #3 from the response property oneOf list for the response status

  • 7ed7a764efd9Revision changes
    • info

      added the non-success response with the status