Search Posts
GET {{baseUrl}}/api/v2/help_center/community_posts/search?query=<string>&topic=<integer>&created_before=<dateTime>&created_after=<dateTime>&created_at=<dateTime>&updated_before=<dateTime>&updated_after=<dateTime>&updated_at=<dateTime>&sort_by=<string>&sort_order=<string>
Returns a maximum of 25 posts per page, up to a maximum of 1000 results. See Pagination.
The results are sorted by relevance by default. You can also sort the results by created_at or updated_at.
Pagination
- Offset pagination only
See Pagination.
Returns a maximum of 100 articles per page.
Allowed for
- End users
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
query | string | (Required) Search text to be matched or a search string. Examples: "carrot potato", "''carrot potato''"' | |
topic | string | Search by topic ID. See Filtering by Topic | |
created_before | string | the search to posts created before a given date (format YYYY-MM-DD) | |
created_after | string | Search posts created after a given date (format YYYY-MM-DD) | |
created_at | string | Search posts created on a given date (format YYYY-MM-DD) | |
updated_before | string | Search posts updated before a given date (format YYYY-MM-DD) | |
updated_after | string | Search posts updated after a given date (format YYYY-MM-DD) | |
updated_at | string | Search posts updated on a given date (format YYYY-MM-DD) | |
sort_by | string | Sort by created_at or updated_at. Defaults to sorting by relevance | |
sort_order | string | Sort in ascending or descending order. Default is descending order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"results":[{"title":"\u003cstring\u003e","author_id":"\u003cinteger\u003e","closed":"\u003cboolean\u003e","comment_count":"\u003cinteger\u003e","content_tag_ids":["\u003cinteger\u003e","\u003cinteger\u003e"],"created_at":"\u003cdateTime\u003e","details":"\u003cstring\u003e","featured":"\u003cboolean\u003e","follower_count":"\u003cinteger\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","non_author_editor_id":"\u003cinteger\u003e","non_author_updated_at":"\u003cdateTime\u003e","pinned":"\u003cboolean\u003e","status":"\u003cstring\u003e","topic_id":"\u003cinteger\u003e","updated_at":"\u003cdateTime\u003e","url":"\u003cstring\u003e","vote_count":"\u003cinteger\u003e","vote_sum":"\u003cinteger\u003e"},{"title":"\u003cstring\u003e","author_id":"\u003cinteger\u003e","closed":"\u003cboolean\u003e","comment_count":"\u003cinteger\u003e","content_tag_ids":["\u003cinteger\u003e","\u003cinteger\u003e"],"created_at":"\u003cdateTime\u003e","details":"\u003cstring\u003e","featured":"\u003cboolean\u003e","follower_count":"\u003cinteger\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","non_author_editor_id":"\u003cinteger\u003e","non_author_updated_at":"\u003cdateTime\u003e","pinned":"\u003cboolean\u003e","status":"\u003cstring\u003e","topic_id":"\u003cinteger\u003e","updated_at":"\u003cdateTime\u003e","url":"\u003cstring\u003e","vote_count":"\u003cinteger\u003e","vote_sum":"\u003cinteger\u003e"}]}