- Compatible XF 2.x versions
- 2.3
- Visible branding
- No
A small collection of REST API enhancements.
New Scopes:
New Endpoints:
New Parameters:
New Scopes:
- apikit_user_group:read - Makes the new user-groups endpoint accessible
- apikit_thread_prefix:read - Makes the new thread-prefixes endpoint accessible
New Endpoints:
- user-groups - List of XF Usergroups:
PHP:
<span>Array</span><span>(</span><br> <span>[</span><span>0</span><span>]</span> <span>=</span><span>></span> stdClass Object<br> <span>(</span><br> <span>[</span>banner_css_class<span>]</span> <span>=</span><span>></span> userBanner userBanner<span>--</span>accent<br> <span>[</span>display_style_priority<span>]</span> <span>=</span><span>></span> <span>0</span><br> <span>[</span>title<span>]</span> <span>=</span><span>></span> Unregistered <span>/</span> Unconfirmed<br> <span>[</span>user_group_id<span>]</span> <span>=</span><span>></span> <span>1</span><br> <span>[</span>username_css<span>]</span> <span>=</span><span>></span> color<span>:</span> red<span>;</span> font<span>-</span>weight<span>:</span> bold<span>;</span><br> <span>)</span><br> <span>.</span><span>.</span><span>.</span><br><span>)</span> - thread-prefixes - List of Thread Prefixes:
PHP:
<span>Array</span><span>(</span><br> <span>[</span><span>0</span><span>]</span> <span>=</span><span>></span> stdClass Object<br> <span>(</span><br> <span>[</span>color_label<span>]</span> <span>=</span><span>></span> lightGreen<br> <span>[</span>css_class<span>]</span> <span>=</span><span>></span> label label<span>--</span>lightGreen<br> <span>[</span>description<span>]</span> <span>=</span><span>></span> Prefix description here<span>.</span><br> <span>[</span>display_order<span>]</span> <span>=</span><span>></span> <span>1</span><br> <span>[</span>is_usable<span>]</span> <span>=</span><span>></span> <span>1</span><br> <span>[</span>materialized_order<span>]</span> <span>=</span><span>></span> <span>1</span><br> <span>[</span>prefix_group_id<span>]</span> <span>=</span><span>></span> <span>0</span><br> <span>[</span>prefix_id<span>]</span> <span>=</span><span>></span> <span>1</span><br> <span>[</span>title<span>]</span> <span>=</span><span>></span> Prefix Name<br> <span>[</span>usage_help<span>]</span> <span>=</span><span>></span><br> <span>)</span><br> <span>.</span><span>.</span><span>.</span><br><span>)</span>
New Parameters:
- /threads/
(bool) most_replies - List threads (sitewide) that have been replied to within the last 30 days, sorted by reply count.
(bool) most_viewed - List most viewed threads (sitewide).
Return: List of Thread[] Object(s).
- /users/ - Can now return list of users by usergroup and/or secondary usergroup(s).
(int) user_group_id - Enter ID of usergroup to search users by.
(array) secondary_group_ids - Enter ID(s) of secondary usergroup(s) to search by.
Return: List of User[] Objects.
