---
title: "List details"
method: GET
path: "/lists/details"
tags: ["Lists"]
---

# List details

`GET /lists/details`

## Request

- Base URL: `https://api.twittrapi.com`
- URL: `https://api.twittrapi.com/lists/details`
- Auth: API key in header `X-API-KEY`

Name, description, owner and member and subscriber counts of a list.

Reference: https://www.twittrapi.com/docs/reference/lists-details

## Query parameters

- `listId` string, required
- `format` 'raw' | 'simple'

## Response `200`

Raw JSON of X's ListByRestId query (data.list). X may add an errors array next to complete data when it cannot decode one nested field, e.g. the default banner; the rest of the list is still there.

With format=simple: {data: List}.

- union: format=simple: the simple-format schema. Default (raw): X's JSON, passthrough.
  - ListResult: Simple format: one list
    - `data` List, required
      - `id` string, required
      - `name` string, required
      - `description` string, required
      - `createdAt` string, nullable, required
      - `memberCount` integer, required
      - `followerCount` integer, required
      - `private` boolean, required
      - `bannerUrl` string, nullable, required
      - `owner` object, nullable, required
        - `id` string, required
        - `username` string, required
  - RawPassthrough: X's own JSON (raw format, the default), passed through unchanged. The shape is X's and can change; see https://www.twittrapi.com/docs/response-format.

## Other responses

- `400`: listId is missing or not numeric.
- `401`: Missing or unknown API key. Not charged.
- `402`: No balance left, or the trial expired. Not charged. Top up in the dashboard.
- `403`: Key deactivated, or the endpoint is not in your plan (trial keys and account actions). Not charged.
- `429`: Rate limit for your key exceeded. Not charged. No Retry-After header: back off exponentially.
- `500`: Something failed on our side or between us and X. Refunded (400, 407, 408, 409 or a 5xx error are refunded). Retry with backoff.

---

[API](https://skmtc.dev/twittrapi/apis/twittrapi-api.md) · [All operations](https://skmtc.dev/twittrapi/apis/twittrapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/twittrapi/apis/twittrapi-api/revisions/0618e38b54c2?raw)