Lists
Type definitions for the Lists API.
Types related to the ListsAPI namespace.
ListMutationResponse
Standard response returned by add_movie, remove_movie, delete, and clear.
Prop
Type
ListMutationParams
Shared query params for list endpoints that require a session ID and list ID.
Prop
Type
ListItem
A single movie item inside a TMDB v3 list.
Prop
Type
ListDetails
Full details of a TMDB v3 list, including all items.
Prop
Type
ListDetailsParams
Query params for lists.details().
| Name | Type | Required | Description |
|---|---|---|---|
list_id | number | ✅ | TMDB list ID. |
language | string | ❌ | ISO 639-1 language code. Defaults to en-US. |
page | number | ❌ | Page number. Defaults to 1. |
ListCreateBody
Request body for lists.create().
Prop
Type
ListCreateParams
Query params for lists.create().
Prop
Type
ListCreateResponse
Response from lists.create().
Prop
Type
ListMovieBody
Shared request body for lists.add_movie() and lists.remove_movie().
Prop
Type
ListClearParams
Query params for lists.clear().
Prop
Type
ListItemStatusParams
Query params for lists.check_item_status().
| Name | Type | Required | Description |
|---|---|---|---|
list_id | number | ✅ | TMDB list ID. |
language | string | ❌ | ISO 639-1 language code. Defaults to en-US. |
movie_id | number | ❌ | TMDB movie ID to check for. |
ListItemStatusResponse
Response from lists.check_item_status().
Prop
Type