---
title: "Get Index By ID"
method: GET
path: "/v0/indices/{index_id}"
tags: ["目录"]
---

# Get Index By ID

`GET /v0/indices/{index_id}`

## Request

- The document declares no server URL.
- Auth: HTTP bearer

## Path parameters

- `index_id` integer, required

## Response `200`

Successful Response

- Index
  - `id` integer, required
  - `title` string, required
  - `desc` string, required
  - `total` integer: 收录条目总数
  - `stat` Stat, required
    - `comments` integer, required
    - `collects` integer, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `creator` Creator, required: 意义同<a href="#model-Me">Me</a>
    - `username` string, required
    - `nickname` string, required
  - `ban` boolean, required: deprecated, always false.
  - `nsfw` boolean, required

## Other responses

- `404`: Not Found

## Changes

- **2023-05-03** (v0) `adaa40a09e57`: 1 info
  - response property `ban` deprecated
- **2022-11-19** (v0) `bb6bcec42206`: 1 warning, 1 info
  - removed the optional property `detail` from the response with the `404` status
  - added the optional property `details` to the response with the `404` status
- **2022-10-24** (v0) `bbacb4142fa3`: 2 info
  - removed the non-success response with the status `400`
  - added the required property `updated_at` to the response with the `200` status
- **2022-06-21** (v0) `849933a48cb4`: 1 breaking
  - for the `path` request parameter `index_id`, the min was increased from `0.00` to `1.00`
- **2022-05-07** (v0) `588c3a75d5cd`: 4 breaking, 4 warning
  - added `subschema #1, subschema #2` to the `detail` response property `oneOf` list for the response status `400`
  - added `subschema #1, subschema #2` to the `detail` response property `oneOf` list for the response status `404`
  - the `detail` response's property type changed from `object` to no type for status `400`
  - the `detail` response's property type changed from `object` to no type for status `404`
  - …4 more

[Operation history](https://skmtc.dev/bangumi/apis/bangumi-open-api/changes/v0/indices/:index_id/get.md)

---

[API](https://skmtc.dev/bangumi/apis/bangumi-open-api.md) - [All operations](https://skmtc.dev/bangumi/apis/bangumi-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bangumi/apis/bangumi-open-api/revisions/6aafdbda7895?raw)