v1

latestOpenAPI 3.1.02026-07-2615426267.4 KB
Threads

Get Threads

List of threads in a forum (with pagination).

Required scopes:

  • read
get/threads

Query parameters

forum_idinteger

Id of the containing forum.

Id of the containing forum.

tabstring

Tab to get threads from.

Example:main

Tab to get threads from.

state'active' | 'closed'

Thread state. Works only if forum_id is set.

Thread state. Works only if forum_id is set.

period'day' | 'week' | 'month' | 'year'

Filter to get only threads created within the selected period. Works only if forum_id is set.

Filter to get only threads created within the selected period. Works only if forum_id is set.

titlestring

Thread title.

Thread title.

title_onlyboolean

Search only in titles.

Search only in titles.

creator_user_idinteger

Filter to get only threads created by the specified user.

Filter to get only threads created by the specified user.

stickyboolean

Filter to get only sticky or non-sticky threads. By default, all threads will be included and sticky ones will be at the top of the result on the first page. In mixed mode, sticky threads are not counted towards threads_total and does not affect pagination.

Filter to get only sticky or non-sticky threads. By default, all threads will be included and sticky ones will be at the top of the result on the first page. In mixed mode, sticky threads are not counted towards threads_total and does not affect pagination.

prefix_ids[]integer[]

Filter to get only threads with the specified prefix.

Filter to get only threads with the specified prefix.

prefix_ids_not[]integer[]

Filter to get only threads without the specified prefix.

Filter to get only threads without the specified prefix.

thread_tag_idinteger

Filter to get only threads with the specified tag.

Filter to get only threads with the specified tag.

pageinteger

Page number of threads.

Page number of threads.

limitinteger

Number of threads in a page.

Number of threads in a page.

order'post_date' | 'last_post_date' | 'reply_count' | 'reply_count_asc' | 'first_post_likes' | 'vote_count'

Ordering of threads.

Ordering of threads.

direction'asc' | 'desc'

Direction of threads ordering.

Direction of threads ordering.

thread_create_dateinteger

Filter threads by creation date. Only works with 'thread_create_date' and 'thread_create_date_reverse' ordering.

Filter threads by creation date. Only works with 'thread_create_date' and 'thread_create_date_reverse' ordering.

thread_update_dateinteger

Filter threads by update date. Only works with 'thread_update_date' and 'thread_update_date_reverse' ordering.

Filter threads by update date. Only works with 'thread_update_date' and 'thread_update_date_reverse' ordering.

fields_includestring[]

List of fields to include.

Response

Successful Response.

tabTitlestring nullable required
threads_totalinteger required