Jump to content

Community

REST API Documentation

/forums/topics


Get list of topics

For requests using an OAuth Access Token for a particular member, only topics the authorized user can view will be included


Parameters

Name Type Description
forums string Comma-delimited list of forum IDs
authors string Comma-delimited list of member IDs - if provided, only topics started by those members are returned
hasBestAnswer int If 1, only topics with a best answer are returned, if 0 only without
hasPoll int If 1, only topics with a poll are returned, if 0 only without
locked int If 1, only topics which are locked are returned, if 0 only unlocked
hidden int If 1, only topics which are hidden are returned, if 0 only not hidden
pinned int If 1, only topics which are pinned are returned, if 0 only not pinned
featured int If 1, only topics which are featured are returned, if 0 only not featured
archived int If 1, only topics which are archived are returned, if 0 only not archived
sortBy string What to sort by. Can be 'date', 'title' or leave unspecified for ID
sortDir string Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
page int Page number
perPage int Number of results per page - defaults to 25

Exceptions

This endpoint doesn't throw any exceptions.

Response

Name Type Description
page int The page number for the results being shown
perPage int The number of results that will be on each page
totalResults int The total number of results
totalPages int The number of pages of results
results array of topic objects The results for this page

topic object

Name Type Description
id int ID number
title string Title
forum forum object Forum
posts int Number of posts
views int Number of views
prefix string The prefix tag, if there is one
tags array of strings The tags
firstPost post object The first post in the topic
lastPost post object The last post in the topic
bestAnswer post object The best answer, if this is a question and there is one
locked bool Topic is locked
hidden bool Topic is hidden
pinned bool Topic is pinned
featured bool Topic is featured
archived bool Topic is archived
poll poll object Poll data, if there is one
url string URL
rating float Average Rating

forum object

Name Type Description
id int ID number
name string Forum name
topics int Number of topics in forum
url string URL
permissions bject|null object Node permissions

post object

Name Type Description
id int ID number
item_id int The ID number of the item this belongs to
author member object Author
date datetime Date
content string The content
hidden bool Is hidden?
url string URL to content

member object

Name Type Description
id int ID number
name string Username
title string Member title
timezone string Member timezone
formattedName string Username with group formatting
ipAddress string IP address used during registration
primaryGroup group object Primary group
secondaryGroups array of group objects Secondary groups
email string Email address
joined datetime Registration date
registrationIpAddress string IP address when registered
warningPoints int Number of active warning points
reputationPoints int Number of reputation points
photoUrl string URL to photo (which will be the site's default if they haven't set one)
photoUrlIsDefault bool Indicates if the value of photoUrl is the site's default
coverPhotoUrl string URL to profile cover photo (will be blank if there isn't one)
profileUrl tring|null object URL to profile
validating bool Whether or not the validating flag is set on the member account
posts int Number of content item submissions member has made
lastActivity atetime|null object Last activity date on the site
lastVisit atetime|null object Last distinct visit date on the site
lastPost atetime|null object Latest content submission date
profileViews int Number of times member's profile has been viewed
birthday string Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied)
customFields array of fieldgroup objects Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting

fieldgroup object

Name Type Description
name string Group name
fields array of field objects Fields

field object

Name Type Description
name string Field name
value string Value

poll object

Name Type Description
id int ID number
title string Title
votes int Number of votes
questions array of question objects The questions

question object

Name Type Description
question string The question
options object Each of the options and how many votes they have had
×
×
  • Create New...