Search a Post

This endpoint performs search operation to posts

info

This operation requires authentication only if content_availability community option is false.

HTTP Request

GET /api/v2/post/search/

Parameters

Name	In	Type	Required	Description
search	query	string	false	A search term

Example Request

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/post/search/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Bash

# You can also use wget
curl -X GET /api/v2/post/search/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» count	integer	true	none	Total results count
» next	string¦null	false	none	Next page url
» previous	string¦null	false	none	Previous page url
» results	list(SearchPost)	true	none	List of results

Example responses

200

{
  "count": "integer",
  "next": "string(uri)",
  "previous": "string(uri)",
  "results": [
      {
        "id": "integer",
        "type": "string",
        "last_activity_at": "string",
        "author": {User},
        "added_at": "string",
        "last_edited_at": "string",
        "html": "string",
        "summary": "string",
        "deleted": "boolean",
        "collapsed": "boolean",
        "comment_count": "integer",
        "view_count": "integer",
        "vote_count": "integer",
        "reactions_count": [{Reaction}],
        "voted": "boolean",
        "reaction": {Reaction},
        "follower_count": "integer",
        "followed": "boolean",
        "suspended": "boolean",
        "flag_count": "integer",
        "share_count": "integer",
        "slug": "string",
        "categories": [{Category}],
        "medias": [{Media}],
        "location": {Locality},
        "addressing": ["integer"],
        "tags": ["integer"],
        "poll": {Poll}
        "matches": [
        {
        "object": {
            "id": "integer",
            "type": "comment",
            "added_at": "string",
            "html": "string"
        },
        "author": {}
        }
        ]
      }
    ]
}