Lists

List details

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

Reference: https://www.twittrapi.com/docs/reference/lists-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

Query parameters

listIdstring required

Numeric list ID, the number in the list URL (x.com/i/lists/<listId>).

format'raw' | 'simple'

raw (default): X's JSON passed through. simple: flat camelCase JSON with a fixed schema and a {data, nextCursor, previousCursor, hasNextPage} envelope. Same price. The header X-Response-Format: simple does the same.

Response

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}.

OR
RawPassthrough required

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.

Changes

No recorded changes to this operation across all 1 revision of this API.