---
title: "Index IDs for an object type"
method: GET
path: "/index"
tags: ["Browsing, Indexes and Lists"]
---

# Index IDs for an object type

`GET /index`

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

## Query parameters

- `type` string, required
- `filter` string
- `hide_search` 0 | 1
- `exact` 0 | 1
- `add` string, date
- `update` string, date
- `include` 0 | 1
- `offset` integer
- `limit` integer
- `cond` string
- `sort` string

## Response `200`

Index response

- IndexResponse — 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.

## Other responses

- `400` — HTTP 400 Bad Request (errors 4705, 4710).
- `401` — HTTP 401 Unauthorized (error 4701).
- `403` — HTTP 403 Forbidden (errors 4700, 4703, 4742).
- `404` — HTTP 404 Not Found (error 4704).
- `500` — HTTP 500 Internal Server Error (error 4702).

---

[API](https://skmtc.net/ampache/apis/ampache-rest-api.md) · [All operations](https://skmtc.net/ampache/apis/ampache-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ampache/ampache-rest-api/revisions/535feee32afb/schema)