API

API

Routes

Attachments

Auth

Conversations

Forums

Index

Me

Nodes

Posts

Profile posts

Threads

Users

resource-categories

resource-reviews

resource-updates

resource-versions

resources

GET attachments/
Gets the attachments associated with the provided API attachment key. Only returns attachments that have not been associated with content.

Parameters

Input Type Description
key string The API attachment key

Response

Output Type Description
attachments Attachment[] List of matching attachments.

POST attachments/
Uploads an attachment. An API attachment key must be created first. Must be submitted using multipart/form-data encoding.

Parameters

Input Type Description
key string The API attachment key to associated with
attachment file The attachment file

Response

Output Type Description
attachment Attachment The attachment record of the successful upload

Errors

Error key Description
attachment_key_user_wrong Triggered if the user making the request does not match the user that created the attachment key.

POST attachments/new-key
Creates a new attachment key, allowing attachments to be uploaded separately from the related content.

Parameters

Input Type Description
type string The content type of the attachment. Default types include post, conversation_message. Add-ons may add more.
context string[] Key-value pairs representing the context of the attachment. This will vary depending on content type and the action being taken. See relevant actions for further details.
attachment file The first attachment to be associated with the new key.

Response

Output Type Description
key string The attachment key created. This should be used to upload additional files or to associate uploaded attachments with other content.
attachment Attachment If a file was provided and the upload was successful, this will describe the new attachment.

GET attachments/{id}/
Gets information about the specified attachment.

Parameters

Input Type Description
None.

Response

Output Type Description
attachment Attachment  

DELETE attachments/{id}/
Delete's the specified attachment.

Parameters

Input Type Description
None.

Response

Output Type Description
success true  

GET attachments/{id}/data
Gets the data that makes up the specified attachment. The output is the raw binary data.

Parameters

Input Type Description
None.

Response

Output Type Description
data binary The binary data is output directly, not JSON.

GET attachments/{id}/thumbnail
Gets the URL to the attachment's thumbnail, if it has one. URL returned via a 301 redirect.

Parameters

Input Type Description
None.

Response

Output Type Description
url string The URL to the thumbnail is returned via a 301 redirect's Location header.

Errors

Error key Description
not_found Not found if the attachment does not have a thumbnail

POST auth/
Tests a login and password for validity. Only available to super user keys.

Parameters

Input Type Description
login string The username or email address of the user to test
password string The password of the user
limit_ip string The IP that should be considered to be making the request. If provided, this will be used to prevent brute force attempts.

Response

Output Type Description
user User If successful, the user record of the matching user

POST conversation-messages/
Replies to a conversation

Parameters

Input Type Description
conversation_id integer
message string
attachment_key string API attachment key to upload files. Attachment key content type must be conversation_message with context[conversation_id] set to this conversation ID.

Response

Output Type Description
success true  
message ConversationMessage The newly inserted message

GET conversation-messages/{id}/
Gets the specified conversation message.

Parameters

Input Type Description
None.

Response

Output Type Description
message ConversationMessage  

POST conversation-messages/{id}/
Updates the specified conversation message.

Parameters

Input Type Description
message string The new message content
attachment_key string API attachment key to upload files. Attachment key content type must be conversation_message with context[message_id] set to this message ID.

Response

Output Type Description
success true  
message ConversationMessage  

POST conversation-messages/{id}/react
Reacts to the specified conversation message

Parameters

Input Type Description
reaction_id integer ID of the reaction to use. Use the current reaction ID to undo.

Response

Output Type Description
success true  
action string "insert" or "delete" based on whether the reaction was added or removed.

GET conversations/
Gets the API user's list of conversations.

Parameters

Input Type Description
page integer  

Response

Output Type Description
conversations Conversation[]  
pagination pagination  

POST conversations/
Creates a conversation

Parameters

Input Type Description
recipient_ids integer[] List of user IDs to send the conversation to
title string Conversation title
message string Conversation message body
attachment_key string API attachment key to upload files. Attachment key content type must be conversation_message with no context.
conversation_open bool If false, no replies may be made to this conversation.
open_invite bool If true, any member of the conversation may add others

Response

Output Type Description
success true  
conversation Conversation  

GET conversations/{id}/
Gets information about the specified conversation.

Parameters

Input Type Description
with_messages bool If specified, the response will include a page of messages.
page integer The page of messages to include

Response

Output Type Description
conversation Conversation  
messages ConversationMessage[] List of messages on the requested page
pagination pagination Pagination details

POST conversations/{id}/
Updates the specified conversation

Parameters

Input Type Description
title string Conversation title
open_invite bool If true, any member of the conversation can add others
conversation_open bool If false, no further replies are allowed.

Response

Output Type Description
success true  
conversation Conversation  

DELETE conversations/{id}/
Deletes the specified conversation from the API user's list. Does not delete the conversation for other receivers.

Parameters

Input Type Description
ignore bool If true, further replies to this conversation will be ignored. (Otherwise, replies will restore this conversation to the list.)

Response

Output Type Description
success true  

POST conversations/{id}/invite
Invites the specified users to this conversation.

Parameters

Input Type Description
recipient_ids integer[] List of user IDs to invite

Response

Output Type Description
success true  

GET conversations/{id}/messages
Gets a page of messages in the specified conversation.

Parameters

Input Type Description
page integer  

Response

Output Type Description
messages ConversationMessage[] List of messages on the requested page
pagination pagination Pagination details

POST conversations/{id}/star
Sets the star status of the specified conversation

Parameters

Input Type Description
star bool If provided, sets the star status as specified. If not provided, toggles the status.

Response

Output Type Description
success true  

GET forums/{id}/
Gets information about the specified forum

Parameters

Input Type Description
with_threads bool If true, gets a page of threads in this forum
page integer  

Response

Output Type Description
forum Forum  
threads Thread[] Threads on this page
pagination pagination Pagination information
sticky Thread[] If on page 1, a list of sticky threads in this forum. Does not count towards the per page limit.

GET forums/{id}/threads
Gets a page of threads from the specified forum.

Parameters

Input Type Description
None.

Response

Output Type Description
threads Thread[] Threads on this page
pagination pagination Pagination information
sticky Thread[] If on page 1, a list of sticky threads in this forum. Does not count towards the per page limit.

GET index/
Gets general information about the site and the API

Parameters

Input Type Description
None.

Response

Output Type Description
version_id integer XenForo version ID
site_title string Title of the site this API relates to
base_url string The base URL of the XenForo install this API relates to
api_url string The base API URL
key[type] string Type of the API key accessing the API (guest, user or super)
key[user_id] integer|null If a user key, the ID of the user the key is for; null otherwise
key[allow_all_scopes] bool If true, all scopes can be accessed
key[scopes] string[] A list of scopes this key can access (if not allowed to access all scopes)

GET me/
Gets information about the current API user

Parameters

Input Type Description
None.

Response

Output Type Description
me User  

POST me/
Updates information about the current user

Parameters

Input Type Description
option[creation_watch_state] string  
option[interaction_watch_state] string  
option[content_show_signature] bool  
option[email_on_conversation] bool  
option[push_on_conversation] bool  
option[receive_admin_email] bool  
option[show_dob_year] bool  
option[show_dob_date] bool  
profile[location] string  
profile[website] string  
profile[about] string  
profile[signature] string  
privacy[allow_view_profile] string  
privacy[allow_post_profile] string  
privacy[allow_receive_news_feed] string  
privacy[allow_send_personal_conversation] string  
privacy[allow_view_identities] string  
visible bool  
activity_visible bool  
timezone string  
custom_title string  
custom_fields[<name>] string  

Response

Output Type Description
success true  

POST me/avatar
Updates the current user's avatar

Parameters

Input Type Description
avatar file The uploaded new avatar

Response

Output Type Description
success true  

DELETE me/avatar
Deletes the current user's avatar

Parameters

Input Type Description
None.

Response

Output Type Description
success true  

POST me/email
Updates the current user's email address

Parameters

Input Type Description
current_password string
email string

Response

Output Type Description
success true  
confirmation_required bool True if email confirmation is required for this change

POST me/password
Updates the current user's password

Parameters

Input Type Description
current_password string
new_password string

Response

Output Type Description
success true  

GET nodes/
Gets the node tree.

Parameters

Input Type Description
None.

Response

Output Type Description
tree_map array A mapping that connects node parent IDs to a list of their child node IDs
nodes Node[] List of all nodes

POST nodes/
Creates a new node

Parameters

Input Type Description
node[title] string
node[node_name] string  
node[description] string  
node[parent_node_id] integer
node[display_order] integer  
type_data array Type-specific node data. The available options will vary based on the node type involved.
node_type_id string

Response

Output Type Description
node Node Information about the created node

GET nodes/flattened
Gets a flattened node tree. Traversing this will return a list of nodes in the expected order.

Parameters

Input Type Description
None.

Response

Output Type Description
nodes_flat array An array. Each entry contains keys of "node" and "depth"

GET nodes/{id}/
Gets information about the specified node

Parameters

Input Type Description
None.

Response

Output Type Description
node Node  

POST nodes/{id}/
Updates the specified node

Parameters

Input Type Description
node[title] string  
node[node_name] string  
node[description] string  
node[parent_node_id] integer  
node[display_order] integer  
type_data array Type-specific node data. The available options will vary based on the node type involved.

Response

Output Type Description
node Node The updated node information

DELETE nodes/{id}/
Deletes the specified node

Parameters

Input Type Description
delete_children bool If true, child nodes will be deleted. Otherwise, they will be connected to this node's parent.

Response

Output Type Description
success true  

POST posts/
Adds a new reply to a thread.

Parameters

Input Type Description
thread_id integer ID of the thread to reply to.
message string
attachment_key string API attachment key to upload files. Attachment key context type must be post with context[thread_id] set to this thread ID.

Response

Output Type Description
None.

GET posts/{id}/
Gets information about the specified post

Parameters

Input Type Description
None.

Response

Output Type Description
post Post  

POST posts/{id}/
Updates the specified post

Parameters

Input Type Description
message string  
silent bool If true and permissions allow, this edit will not be updated with a "last edited" indication
clear_edit bool If true and permissions allow, any "last edited" indication will be removed. Requires "silent".
author_alert bool  
author_alert_reason string  
attachment_key string API attachment key to upload files. Attachment key context type must be post with context[post_id] set to this post ID.

Response

Output Type Description
success true  
post Post  

DELETE posts/{id}/
Deletes the specified post. Default to soft deletion.

Parameters

Input Type Description
hard_delete bool  
reason string  
author_alert bool  
author_alert_reason string  

Response

Output Type Description
success true  

POST posts/{id}/react
Reacts to the specified post

Parameters

Input Type Description
reaction_id integer ID of the reaction to use. Use the current reaction ID to undo.

Response

Output Type Description
success true  
action string "insert" or "delete" based on whether the reaction was added or removed.

POST profile-post-comments/
Creates a new profile post comment.

Parameters

Input Type Description
profile_post_id integer The ID of the profile post this comment will be attached to.
message string

Response

Output Type Description
success true  
comment ProfilePostComment  

GET profile-post-comments/{id}/
Gets information about the specified profile post comment.

Parameters

Input Type Description
None.

Response

Output Type Description
comment ProfilePostComment  

POST profile-post-comments/{id}/
Updates the specified profile post comment.

Parameters

Input Type Description
message string  
author_alert bool  
author_alert_reason bool  

Response

Output Type Description
success true  
comment ProfilePostComment  

DELETE profile-post-comments/{id}/
Deletes the specified profile post comment. Default to soft deletion.

Parameters

Input Type Description
hard_delete bool  
reason string  
author_alert bool  
author_alert_reason string  

Response

Output Type Description
success true  

POST profile-post-comments/{id}/react
Reacts to the specified profile post comment

Parameters

Input Type Description
reaction_id integer ID of the reaction to use. Use the current reaction ID to undo.

Response

Output Type Description
success true  
action string "insert" or "delete" based on whether the reaction was added or removed.

POST profile-posts/
Creates a new profile post.

Parameters

Input Type Description
user_id integer The ID of the user whose profile this will be posted on.

Response

Output Type Description
None.

GET profile-posts/{id}/
Gets information about the specified profile post.

Parameters

Input Type Description
with_comments bool If specified, the response will include a page of comments.
page integer The page of comments to include

Response

Output Type Description
profile_post ProfilePost  
comments ProfilePostComment[] List of comments on the requested page
pagination pagination Pagination details

POST profile-posts/{id}/
Updates the specified profile post.

Parameters

Input Type Description
message string  
author_alert bool  
author_alert_reason bool  

Response

Output Type Description
success true  
profile_post ProfilePost  

DELETE profile-posts/{id}/
Deletes the specified profile post. Default to soft deletion.

Parameters

Input Type Description
hard_delete bool  
reason string  
author_alert bool  
author_alert_reason string  

Response

Output Type Description
success true  

GET profile-posts/{id}/comments
Gets a page of comments on the specified profile post.

Parameters

Input Type Description
page integer  

Response

Output Type Description
comments ProfilePostComment[] List of comments on the requested page
pagination pagination Pagination details

POST profile-posts/{id}/react
Reacts to the specified profile post

Parameters

Input Type Description
reaction_id integer ID of the reaction to use. Use the current reaction ID to undo.

Response

Output Type Description
success true  
action string "insert" or "delete" based on whether the reaction was added or removed.

GET threads/
Gets a list of threads

Parameters

Input Type Description
page integer  

Response

Output Type Description
threads Thread[]  
pagination pagination  

POST threads/
Creates a thread.

Parameters

Input Type Description
node_id integer ID of the forum to create the thread in.
title string Title of the thread.
message string Body of the first post in the thread.
prefix_id integer ID of the prefix to apply to the thread. If not valid in the selected forum, will be ignored.
tags string[] Array of tag names to apply to the thread.
custom_fields[<name>] string Value to apply to the custom field with the specified name.
discussion_open bool  
sticky bool  
attachment_key string API attachment key to upload files. Attachment key context type must be post with context[node_id] set to the ID of the forum this is being posted in.

Response

Output Type Description
success true  
thread Thread  

Errors

Error key Description
no_permission No permission error.

GET threads/{id}/
Gets information about the specified thread.

Parameters

Input Type Description
with_posts bool If specified, the response will include a page of posts.
page integer The page of posts to include

Response

Output Type Description
thread Thread  
messages Post[] List of posts on the requested page
pagination pagination Pagination details

POST threads/{id}/
Updates the specified thread

Parameters

Input Type Description
prefix_id integer  
title string  
discussion_open bool  
sticky bool  
custom_fields[<name>] string  
add_tags array  
remove_tags array  

Response

Output Type Description
success true  
thread Thread  

DELETE threads/{id}/
Deletes the specified thread. Default to soft deletion.

Parameters

Input Type Description
hard_delete bool  
reason string  
starter_alert bool  
starter_alert_reason string  

Response

Output Type Description
success true  

GET threads/{id}/posts
Gets a page of posts in the specified conversation.

Parameters

Input Type Description
page integer  

Response

Output Type Description
messages Post[] List of posts on the requested page
pagination pagination Pagination details

GET users/
Gets a list of users (alphabetically)

Parameters

Input Type Description
page integer  

Response

Output Type Description
users User[]  
pagination pagination  

POST users/
Creates a user.

Parameters

Input Type Description
option[creation_watch_state] string  
option[interaction_watch_state] string  
option[content_show_signature] bool  
option[email_on_conversation] bool  
option[push_on_conversation] bool  
option[receive_admin_email] bool  
option[show_dob_year] bool  
option[show_dob_date] bool  
profile[location] string  
profile[website] string  
profile[about] string  
profile[signature] string  
privacy[allow_view_profile] string  
privacy[allow_post_profile] string  
privacy[allow_receive_news_feed] string  
privacy[allow_send_personal_conversation] string  
privacy[allow_view_identities] string  
visible bool  
activity_visible bool  
timezone string  
custom_title string  
option[is_discouraged] bool  
username string  
email string  
user_group_id integer  
secondary_group_ids integer[]  
user_state string  
is_staff bool  
message_count integer  
reaction_score integer  
trophy_points integer  
password string  
dob[day] integer  
dob[month] integer  
dob[year] integer  
custom_fields[<name>] string  

Response

Output Type Description
success true  
user User  

GET users/find-name
Finds users by a prefix of their user name.

Parameters

Input Type Description
username string [required]

Response

Output Type Description
exact User|null The user that matched the given username exactly
recommendations User[] A list of users that match the prefix of the username (but not exactly)

GET users/{id}/
Gets information about the specified user.

Parameters

Input Type Description
with_posts bool If specified, the response will include a page of profile posts.
page integer The page of comments to include

Response

Output Type Description
user User  
profile_posts ProfilePost[] List of profile posts on the requested page
pagination pagination Pagination details

POST users/{id}/
Updates an existing user.

Parameters

Input Type Description
option[creation_watch_state] string  
option[interaction_watch_state] string  
option[content_show_signature] bool  
option[email_on_conversation] bool  
option[push_on_conversation] bool  
option[receive_admin_email] bool  
option[show_dob_year] bool  
option[show_dob_date] bool  
profile[location] string  
profile[website] string  
profile[about] string  
profile[signature] string  
privacy[allow_view_profile] string  
privacy[allow_post_profile] string  
privacy[allow_receive_news_feed] string  
privacy[allow_send_personal_conversation] string  
privacy[allow_view_identities] string  
visible bool  
activity_visible bool  
timezone string  
custom_title string  
option[is_discouraged] bool  
username string  
email string  
user_group_id integer  
secondary_group_ids integer[]  
user_state string  
is_staff bool  
message_count integer  
reaction_score integer  
trophy_points integer  
password string  
dob[day] integer  
dob[month] integer  
dob[year] integer  
custom_fields[<name>] string  

Response

Output Type Description
success true  
user User  

DELETE users/{id}/
Deletes the specified user

Parameters

Input Type Description
rename_to string If specified, the user will be renamed before deletion

Response

Output Type Description
success true  

POST users/{id}/avatar
Updates the specified user's avatar

Parameters

Input Type Description
avatar file The uploaded new avatar

Response

Output Type Description
success true  

DELETE users/{id}/avatar
Deletes the specified user's avatar

Parameters

Input Type Description
None.

Response

Output Type Description
success true  

GET users/{id}/profile-posts
Gets a page of profile posts on the specified user's profile.

Parameters

Input Type Description
page integer  

Response

Output Type Description
profile_posts ProfilePost[] List of profile posts on the requested page
pagination pagination Pagination details

GET resource-categories/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resource-categories/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resource-categories/flattened
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resource-categories/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resource-categories/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

DELETE resource-categories/{id}/
Deletes the specified category

Parameters

Input Type Description
delete_children bool If true, child nodes will be deleted. Otherwise, they will be connected to this node's parent.

Response

Output Type Description
success true  

GET resource-categories/{id}/resources
Gets a page of resources from the specified category.

Parameters

Input Type Description
None.

Response

Output Type Description
resources ResourceItem[] Resources on this page
pagination pagination Pagination information

GET resource-reviews/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resource-reviews/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resource-reviews/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

DELETE resource-reviews/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resource-reviews/{id}/author-reply
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

DELETE resource-reviews/{id}/author-reply
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resource-updates/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resource-updates/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resource-updates/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

DELETE resource-updates/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resource-versions/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resource-versions/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

DELETE resource-versions/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resource-versions/{id}/download
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resources/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resources/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resources/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

POST resources/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

DELETE resources/{id}/
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resources/{id}/reviews
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resources/{id}/updates
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

GET resources/{id}/versions
[Incomplete]

Parameters

Input Type Description
Unknown, documentation incomplete

Response

Output Type Description
Unknown, documentation incomplete

Data type: LinkForum

Column Type Description
link_url string  
redirect_count integer  

Data type: UserField

Column Type Description
field_id string  
title string  
description string  
display_order integer  
field_type string  
field_choices object For choice types, an ordered list of choices, with "option" and "name" keys for each.
match_type string  
match_params array  
max_length integer  
required bool  
display_group string If this field type supports grouping, the group this field belongs to.

Data type: Forum

Column Type Description
allow_posting bool  
allow_poll bool  
require_prefix bool  
min_tags integer  

Data type: ProfilePost

Column Type Description
username string  
can_edit bool  
can_soft_delete bool  
can_hard_delete bool  
can_react bool  
ProfileUser User If requested by context, the user this profile post was left for.
LatestComments ProfilePostComment[] If requested, the most recent comments on this profile post.
is_reacted_to bool True if the viewing user has reacted to this content
visitor_reaction_id integer If the viewer reacted, the ID of the reaction they used
profile_post_id integer  
profile_user_id integer  
user_id integer  
post_date integer  
message string  
message_state string  
warning_message string  
comment_count integer  
first_comment_date integer  
last_comment_date integer  
reaction_score integer  
User User  

Data type: ThreadPrefix

Column Type Description
prefix_id integer  
title string  
is_usable bool True if the acting user can use (select) this prefix.
prefix_group_id integer  
display_order integer  
materialized_order integer Effective order, taking group ordering into account.

Data type: Post

Column Type Description
username string  
is_first_post bool  
is_last_post bool  
can_edit bool  
can_soft_delete bool  
can_hard_delete bool  
can_react bool  
can_view_attachments bool  
Thread Thread If requested by context, the thread this post is part of.
Attachments Attachment[] Attachments to this post, if it has any.
is_reacted_to bool True if the viewing user has reacted to this content
visitor_reaction_id integer If the viewer reacted, the ID of the reaction they used
post_id integer  
thread_id integer  
user_id integer  
post_date integer  
message string  
message_state string  
attach_count integer  
warning_message string  
position integer  
last_edit_date integer  
reaction_score integer  
User User  

Data type: ProfilePostComment

Column Type Description
username string  
can_edit bool  
can_soft_delete bool  
can_hard_delete bool  
can_react bool  
ProfilePost ProfilePost If requested by context, the profile post this comment relates to.
is_reacted_to bool True if the viewing user has reacted to this content
visitor_reaction_id integer If the viewer reacted, the ID of the reaction they used
profile_post_comment_id integer  
profile_post_id integer  
user_id integer  
comment_date integer  
message string  
message_state string  
warning_message string  
reaction_score integer  
User User  

Data type: Node

Column Type Description
breadcrumbs array A list of breadcrumbs for this node, including the node_id, title, and node_type_id
type_data object Data related to the specific node type this represents. Contents will vary significantly.
node_id integer  
title string  
node_name string  
description string  
node_type_id string  
parent_node_id integer  
display_order integer  
display_in_list bool  

Data type: Attachment

Column Type Description
filename string  
file_size integer  
height integer  
width integer  
thumbnail_url string  
video_url string  
attachment_id integer  
content_type string  
content_id integer  
attach_date integer  
view_count integer  

Data type: Thread

Column Type Description
username string  
is_watching bool If accessing as a user, true if they are watching this thread
visitor_post_count integer If accessing as a user, the number of posts they have made in this thread
custom_fields object Key-value pairs of custom field values for this thread
tags array  
prefix string Present if this thread has a prefix. Printable name of the prefix.
can_edit bool  
can_edit_tags bool  
can_reply bool  
can_soft_delete bool  
can_hard_delete bool  
can_view_attachments bool  
Forum Node If requested by context, the forum this thread was posted in.
thread_id integer  
node_id integer  
title string  
reply_count integer  
view_count integer  
user_id integer  
post_date integer  
sticky bool  
discussion_state string  
discussion_open bool  
discussion_type string  
first_post_id integer  
last_post_date integer  
last_post_id integer  
last_post_user_id integer  
last_post_username string  
first_post_reaction_score integer  
prefix_id integer  
User User  

Data type: ConversationMessage

Column Type Description
username string  
can_edit bool  
can_react bool  
Conversation Conversation If requested by context, the conversation this message is part of.
Attachments Attachment[] If there are attachments to this message, a list of attachments.
is_reacted_to bool True if the viewing user has reacted to this content
visitor_reaction_id integer If the viewer reacted, the ID of the reaction they used
message_id integer  
conversation_id integer  
message_date integer  
user_id integer  
message string  
attach_count integer  
reaction_score integer  
User User  

Data type: User
Information about the user. Different information will be included based on permissions and verbosity.

Column Type Description
about string
activity_visible bool
age integer The user's current age. Only included if available.
alert_optout array
allow_post_profile string
allow_receive_news_feed string
allow_send_personal_conversation string
allow_view_identities string
allow_view_profile string
avatar_urls object Maps from size types to URL.
can_ban bool  
can_converse bool  
can_edit bool  
can_follow bool  
can_ignore bool  
can_post_profile bool  
can_view_profile bool  
can_view_profile_posts bool  
can_warn bool  
content_show_signature bool
creation_watch_state string
custom_fields object Map of custom field keys and values.
custom_title string Will have a value if a custom title has been specifically set; prefer user_title instead.
dob object Date of birth with year, month and day keys.
email string
email_on_conversation bool
gravatar string
interaction_watch_state bool
is_admin bool
is_banned bool
is_discouraged bool
is_followed bool True if the visitor is following this user. Only included if visitor is not a guest.
is_ignored bool True if the visitor is ignoring this user. Only included if visitor is not a guest.
is_moderator bool
is_super_admin bool
last_activity integer Unix timestamp of user's last activity, if available.
location string  
push_on_conversation bool
push_optout array
receive_admin_email bool
secondary_group_ids array
show_dob_date bool
show_dob_year bool
signature string  
timezone string
use_tfa array
user_group_id integer
user_state string
user_title string  
visible bool
warning_points integer Current warning points.
website string
user_id integer  
username string  
message_count integer  
register_date integer  
trophy_points integer  
is_staff bool  
reaction_score integer  

Data type: ThreadField

Column Type Description
field_id string  
title string  
description string  
display_order integer  
field_type string  
field_choices object For choice types, an ordered list of choices, with "option" and "name" keys for each.
match_type string  
match_params array  
max_length integer  
required bool  
display_group string If this field type supports grouping, the group this field belongs to.

Data type: Page

Column Type Description
publish_date integer  
view_count integer  

Data type: Conversation

Column Type Description
username string Name of the user that started the conversation
recipients object Key-value pair of recipient user IDs and names
is_starred bool True if the viewing user starred the conversation
can_edit bool  
can_reply bool  
can_invite bool  
can_upload_attachment bool  
conversation_id integer  
title string  
user_id integer  
start_date integer  
open_invite bool  
conversation_open bool  
reply_count integer  
recipient_count integer  
first_message_id integer  
last_message_date integer  
last_message_id integer  
last_message_user_id integer  
Starter User  

Data type: XFRM_ResourceVersion

Column Type Description
resource_version_id integer  
resource_id integer  
version_string string  
release_date integer  
download_count integer  
rating_count integer  
version_state string  

Data type: XFRM_ResourceItem

Column Type Description
resource_id integer  
title string  
tag_line string  
user_id integer  
resource_state string  
resource_type string  
resource_date integer  
resource_category_id integer  
external_url string  
price float  
currency string  
view_count integer  
download_count integer  
rating_count integer  
rating_avg float  
rating_weighted float  
last_update integer  
alt_support_url string  
prefix_id integer  
Category XFRM_Category  
User User  

Data type: XFRM_ResourcePrefix

Column Type Description
prefix_id integer  
title string  
is_usable bool True if the acting user can use (select) this prefix.
prefix_group_id integer  
display_order integer  
materialized_order integer Effective order, taking group ordering into account.

Data type: XFRM_ResourceField

Column Type Description
field_id string  
title string  
description string  
display_order integer  
field_type string  
field_choices object For choice types, an ordered list of choices, with "option" and "name" keys for each.
match_type string  
match_params array  
max_length integer  
required bool  
display_group string If this field type supports grouping, the group this field belongs to.

Data type: XFRM_Category

Column Type Description
resource_category_id integer  
title string  
description string  
resource_count integer  
last_update integer  
last_resource_title string  
last_resource_id integer  
allow_local bool  
allow_external bool  
allow_commercial_external bool  
allow_fileless bool  
min_tags integer  
enable_versioning bool  
enable_support_url bool  
parent_category_id integer  
display_order integer