API endpoints for searching threads/posts

[TimeWizardCosmo]

I'd like to be able to query an API endpoint or two and get back a list of threads and posts as would be returned by the default search functionality. Thread and post objects should formatted like they're provided when querying those directly and some control over results per page would be helpful.

Any estimates? Shoot me a PM with your offer (but I maybe be slow to reply as we're in the middle of moving).

Thanks!

 

[thetechguy]

These are already available in the default XF API, why you need a custom development for this ?

REST API endpoints (2.2)

This document assumes you have already created an API key and setup the necessary headers for your request. Learn more about using the API.

xenforo.com

Or you need something custom in that ?

 

[TimeWizardCosmo]

I've looked through that, but there doesn't appear to be a way to get a list of threads or posts by "keyword" search. You can get a list of threads from a forum, or get posts from a specified thread ID, but I don't see anything about searching other than using "Search Forums", which aren't what I'm trying to do.

I'd like to be able to send an arbitrary query for something like "john f kennedy" and get back a list of threads and posts that would otherwise show up on the search page.

Found these:

Add-on - Search Results via API

Hi all, I would like to be able to do an API request and search (using XF's search/ElasticSearch), and have the API return the search results back to me. Happy to pay for this and make the API extension available for all. Please PM me if you have API experience, and immediate availability...

xenforo.com

Lack of interest - Search API to query for keywords and get back search results

I think this should be very useful for creating custom landing pages for any specific keywords and fully custom page layout.

xenforo.com

Maybe I'm missing something?

 

[thetechguy]

alright, that needs some custom work.

Sending you the PM for the details

 

[truonglv]

GitHub - luutruong/XF2_MobileAppsApi: Enhancement API to XenForo 2.1.x

Enhancement API to XenForo 2.1.x. Contribute to luutruong/XF2_MobileAppsApi development by creating an account on GitHub.

github.com

It supports search API.

 

[MesterPerfect]

@truonglv
Can I build my own forum desktop app using your extended API options?

 

[truonglv]

@truonglv
Can I build my own forum desktop app using your extended API options?

I think it could be.

 

[MesterPerfect]

I think it could be.

ok, I will try to build a desktop application using your extended API options
But I may have some questions
So is it better for you to ask those questions via issues in github or in add-on thread of your forum
thanks

 

[truonglv]

ok, I will try to build a desktop application using your extended API options
But I may have some questions
So is it better for you to ask those questions via issues in github or in add-on thread of your forum
thanks

Both are fine

 

[Forumly]

@truonglv do you have something similar for the 2.2 API changes?

 

[Forumly]

was anyone able to figure out how to get search on the @truonglv API working? the other endpoints all work but this one seems to be invalid?

I'm not sure if it has to do with the same reason that the XF native API that is documented also returns invalid endpoint or not

 

[Kirby]

You don't need an Add-on, the built-in API has endpoints for searching.

REST API endpoints (2.2)

This document assumes you have already created an API key and setup the necessary headers for your request. Learn more about using the API.

xenforo.com

Post your search to this endpoint and it will return a Search object.

Use search_id from this object to get the results from https://xenforo.com/community/pages/api-endpoints/#route_get_search_id_

 

[Forumly]

You don't need an Add-on, the built-in API has endpoints for searching.

REST API endpoints (2.2)

This document assumes you have already created an API key and setup the necessary headers for your request. Learn more about using the API.

xenforo.com

Post your search to this endpoint and it will return a Search object.

Use search_id from this object to get the results from https://xenforo.com/community/pages/api-endpoints/#route_get_search_id_

Thanks for the reply @Kirby but the problem is that the /search endpoint returns an invalid route error.

 

[Kirby]

Yep, you are right (as of now).

This seems a bit of a bummer to me as there is in fact no code to handle those endpoint URLs.

I've reported this as a bug:

K

Implemented Thread 'API endpoints for Search'

Dec 30, 2025

The API documentation lists search related endpoints that do not exist:

REST API endpoints (2.2)

This document assumes you have already created an API key and setup the necessary headers for your request. Learn more about using the API.

xenforo.com

https://xenforo.com/community/pages/api-endpoints/#route_post_search_member

https://xenforo.com/community/pages/api-endpoints/#route_get_search_id_

https://xenforo.com/community/pages/api-endpoints/#route_post_search_id_older

There is no API route for search and no controller code to handle such requests.

This should be either implemented (Preferred) or removed from the documentation.

• Kirby
• Replies: 1
• Forum: Closed suggestions

• 

 

[Forumly]

thanks @Kirby